آموزش Comment در Java

آموزش Java – آموزش Comment در Java - کامنت گذاری و درج توضیحات در کد برنامه

Comment ها در Java یا هر زبان برنامه نویسی دیگر، دستوراتی هستند که به منظور درج توضیحات درباره ی کد مربوط استفاده شده و کامپایلر یا مفسر آن ها را به عنوان جزئی از برنامه اجرا نمی کند. به عبارت دیگر توسعه دهنده می تواند با بکارگیری comment در کد برنامه ی خود درباره ی اجزا و کامپوننت های مختلف اپلیکیشن نظیر متغیر، متد، کلاس یا هر دستور دیگری توضیحات کاربردی ارائه دهد. علاوه بر موارد ذکر شده، گاهی برنامه نویس از comment برای مخفی سازی دستورات و جلوگیری از اجرای آن ها توسط کامپایلر یا مفسر استفاده می کند.

انواع Comment

در زبان Java سه نوع Comment به شرح زیر وجود دارد:

1. کامنت تک خطی
2. کامنت چند خطی
3. کامنت مستندسازی (Documentation Comment)

تشریح کامنت تک خطی

کامنت تکی خطی برای درج یک خط توضیح در کد برنامه بکار می رود. به عبارت دیگر این نوع کامنت تنها یک خط را کامنت گذاری می کند.

دستور استفاده:

//This is single line comment

مثال کاربردی:

public class CommentExample1 {  
public static void main(String[] args) {  
    int i=10;//Here, i is a variable  
    System.out.println(i);  
}  
}  

خروجی:

10

تشریح کامنت چندخطی

کامنت چند خطی برای کامنت کردن چندین خط در کد برنامه بکار می رود. به عبارت دیگر برنامه نویس می تواند با استفاده از این نوع کامنت چند خط توضیح برای کد ارائه دهد یا چند خط از دستورات برنامه را به صورت کامنت درآورده و از اجرای آن ها جلوگیری کند.

نحوه ی استفاده:

/* 
This  
is  
multi line  
comment 
*/  

مثال کاربردی:

public class CommentExample2 {  
public static void main(String[] args) {  
/* Let's declare and 
 print variable in java. */  
    int i=10;  
    System.out.println(i);  
}  
}  

خروجی:

10

تشریح کامنت مستندسازی (documentation comment)

این نوع کامنت برای ساخت مستندات و توضیحات رسمی جهت توابع کتابخانه ای/API ها بکار می رود. به منظور تعریف مستندات معتبر و رسمی برای توابع کتابخانه ای یا API ها لازم است از ابزار Javadoc استفاده نمایید.

دستور استفاده:

/** 
This  
is  
documentation  
comment 
*/  

مثال کاربردی:

/** The Calculator class provides methods to get addition and subtraction of given 2 numbers.*/  
public class Calculator {  
/** The add() method returns addition of given numbers.*/  
public static int add(int a, int b){return a+b;}  
/** The sub() method returns subtraction of given numbers.*/  
public static int sub(int a, int b){return a-b;}  
}  

آن را با ابزار javac به صورت زیر کامپایل نمایید:

javac Calculator.java

جهت تولید مستندات برای توابع کتابخانه ای جاوا یا Documentation API با ابزار javadoc لازم است از دستور زیر استفاده نمایید:

javadoc Calculator.java

اکنون برای کلاس Calculator برنامه شما در پوشه ی جاری چندین فایل HTML تولید می شود. فایل های HTML مزبور را باز کرده و توضیحات مورد نظر درباره ی کاربرد کلاس Calculator که توسط کامنت مستندسازی تولید شده را مشاهده نمایید.