نظرات (کامنت‌ها)
در زبان جاوا یادداشت‌هایی متنی هستند که در کد نوشته می‌شوند تا توضیحاتی درباره‌ی کد منبع ارائه دهند. از این نظرات می‌توان برای توضیح منطق برنامه یا برای مستندسازی استفاده کرد. کامپایلر، نظرات را کامپایل نمی‌کند. در جاوا، نظرات بسیار شبیه به زبان‌های C و ++C هستند.
در زبان جاوا، سه نوع نظر (کامنت) وجود دارد:
- نظرات تک‌خطی
- نظرات چندخطی
- نظرات مستندسازی (Documentation)
بیایید هر نوع از نظرات را به‌صورت جزئی‌تر بررسی کنیم.
۱. نظر (کامنت) تک‌خطی نظر تک‌خطی برای افزودن نظر تنها در یک خط استفاده می‌شود و با دو اسلش رو به جلو (//) نوشته می‌شود. این نوع نظر، رایج‌ترین روش کامنت‌گذاری است.
نظرات تک‌خطی بیشتر برای توضیح هدف (یا افزودن یادداشت متنی) یک خط خاص از کد استفاده می‌شوند.
نحو (Syntax) نحو نوشتن نظر تک‌خطی در جاوا به صورت زیر است:
// comment
مثال ۱: نظر (کامنت) تک‌خطی در جاوا
// if divisor is 0 throw an exception
if (divisor == 0) {
throw new IllegalArgumentException("divisor cannot be zero");
}
مثال ۲: نظر (کامنت) تک‌خطی در جاوا
کد زیر نحوه استفاده از نظرات تک‌خطی را در یک برنامه ساده نشان می‌دهد. ما به خطوط کد، نظراتی اضافه کرده‌ایم تا هدف آن‌ها را توضیح دهیم.
package com.tutorialspoint;
public class MyFirstJavaProgram {
public static void main(String[] args) {
MyFirstJavaProgram program = new MyFirstJavaProgram();
double result = program.divide(100, 10);
System.out.println(result);
}
private double divide(int dividend, int divisor) throws IllegalArgumentException {
// if divisor is 0 throw an exception
if (divisor == 0) {
throw new IllegalArgumentException("divisor cannot be zero");
}
return (double) dividend / divisor; // returns the result of the division as double
}
}
خروجی
فایل MyFirstJavaProgram را کامپایل و اجرا کنید. این کار خروجی زیر را تولید خواهد کرد −
10.0
۲. نظر (کامنت) چندخطی
نظرات چندخطی (یا نظرات چندین‌خطی) با یک اسلش به همراه یک ستاره (/) شروع می‌شوند و با یک ستاره به همراه یک اسلش (/) پایان می‌یابند و برای افزودن نظر در چندین خط استفاده می‌شوند.
نظرات چندخطی زمانی بسیار مفید هستند که بخواهیم یک نظر طولانی را در چند خط بنویسیم یا کل یک بخش از کد را کامنت کنیم.
نحو (Syntax): در زیر، نحو نوشتن نظر چندخطی در جاوا آورده شده است:
/* Comment (line 1) Comment (line 2) ... */
مثال ۱: نظر (کامنت) چندخطی در جاوا
/* This is an example
of
multi line comment. */
/* if (dividend == 0) {
throw new IllegalArgumentException("dividend cannot be zero");
} */
مثال ۲: نظر (کامنت) چندخطی در جاوا
کد زیر نحوه‌ی استفاده از چندین نظر را در یک برنامه‌ی ساده نشان می‌دهد. ما با استفاده از نظرات چندخطی، بخش اضافی کد را از یک متد کامنت کرده‌ایم.
package com.tutorialspoint;
public class MyFirstJavaProgram {
public static void main(String[] args) {
MyFirstJavaProgram program = new MyFirstJavaProgram();
double result = program.divide(100, 10);
System.out.println(result);
}
private double divide(int dividend, int divisor) throws IllegalArgumentException {
if (divisor == 0) {
throw new IllegalArgumentException("divisor cannot be zero");
}
/* if (dividend == 0) {
throw new IllegalArgumentException("dividend cannot be zero");
} */
return (double) dividend / divisor;
}
}
خروجی
فایل MyFirstJavaProgram را کامپایل و اجرا کنید. این کار خروجی زیر را تولید خواهد کرد −
10.0
۳. نظر (کامنت) مستندسازی
نظرات مستندسازی برای نوشتن مستندات مربوط به کد منبع استفاده می‌شوند. این نوع نظرات با یک اسلش به همراه دو ستاره (/**) آغاز می‌شوند و با یک ستاره به همراه یک اسلش (/) پایان می‌یابند و تمام خطوط بین آغاز و پایان باید با یک ستاره () شروع شوند.
نظرات مستندسازی توسط ابزار Javadoc قابل درک هستند و می‌توان از آن‌ها برای ایجاد مستندات HTMLمحور استفاده کرد.
نحو (Syntax)
در زیر، نحو نوشتن نظر مستندسازی در جاوا آورده شده است:
/** * line 1 * line 2 ... */
مثال ۱: نظر (کامنت) مستندسازی در جاوا
/**
* This is a documentation comment.
* This is my first Java program.
* This will print 'Hello World' as the output
* This is an example of multi-line comments.
*/
public class MyFirstJavaProgram {}
سبک کامنت‌گذاری بالا به‌عنوان نظرات مستندسازی شناخته می‌شود. این سبک توسط ابزار Javadoc هنگام ایجاد مستندات برای کد برنامه استفاده می‌شود. ما می‌توانیم جزئیاتی از آرگومان‌ها، استثناء‌ها و نوع بازگشتی را نیز با استفاده از نشانه‌گذاری‌های زیر در نظرات مستندسازی ارائه دهیم.
/**
* @param dividend
* @param divisor
* @return quotient
* @throws IllegalArgumentException if divisor is zero
*/
private double divide(int dividend, int divisor) throws IllegalArgumentException {
}
مثال ۲: نظر (کامنت) مستندسازی در جاوا
کد زیر نحوه استفاده از نظرات مستندسازی را در یک برنامه ساده نشان می‌دهد. ما یک نظر در اعلام کلاس تعریف کرده‌ایم تا جزئیات کلاس را ارائه دهیم. در مورد متد، جزئیات پارامترها، مقدار بازگشتی و استثنایی که در بلوک مستندسازی بخش نظرات متد اضافه می‌شود، آورده‌ایم.
package com.tutorialspoint;
/**
* This is a documentation comment.
* This is my first Java program.
* This is an example of multi-line comments.
* We're printing result of divison of two numbers in this program
*/
public class MyFirstJavaProgram {
public static void main(String[] args) {
MyFirstJavaProgram program = new MyFirstJavaProgram();
double result = program.divide(100, 10);
System.out.println(result);
}
/**
* @param dividend
* @param divisor
* @return quotient
* @throws IllegalArgumentException if divisor is zero
*/
private double divide(int dividend, int divisor) throws IllegalArgumentException {
if (divisor == 0) {
throw new IllegalArgumentException("divisor cannot be zero");
}
return (double) dividend / divisor;
}
}
خروجی
فایل MyFirstJavaProgram را کامپایل و اجرا کنید. این کار خروجی زیر را تولید خواهد کرد .
