در این آموزش با کامنت ها در جاوا و چرایی و نحوه استفاده از آنها آشنا می شوید.
در برنامه نویسی ، نظرات بخشی از برنامه در نظر گرفته می شوند که برای درک کد استفاده می شوند و توسط کامپایلرهای جاوا کاملا نادیده گرفته شده و اجرا نمی شوند.
در زبان برنامه نویسی جاوا ، دو نوع کامنت وجود دارد:
- /* … */
- // ….
کامنت مرسوم /*…….*/
این یک کامنت چند خطه است که می تواند چندین خطه باشد. کامپایلر جاوا همه چیز را از /* تا */ نادیده می گیرد. مثلا،
/* This is a multi-line comment.
* The problem prints “Hello, World!” to the standard output.
*/
class HelloWorld {
public static void main(String[] args) {
{
System.out.println(“Hello, World!”);
}
}
}
در کد بالا کامنت برابر است با:
/* This is a multi-line comment.
* The problem prints “Hello, World!” to the standard output.
*/
کامنت یک خطه //
کامپایلر همه چیز را از // تا انتهای خط نادیده می گیرد. مثلا،
// “Hello, World!” program
class AssignmentOperator {
public static void main(String[] args) {
{
System.out.println(“Hello, World!”); // prints “Hello, World!”
}
}
}
برنامه فوق شامل دو کامنت یک خطه است:
// “Hello, World!” program
و
// prints “Hello, World!”
از کامنت ها در راه درست استفاده کنید
کامنت ها نباید جایگزینی برای توضیح کد های نوشتاری ضعیف به زبان انگلیسی باشد. کد با ساختار خوب و خواندنی بنویسید و از نظرات استفاده کنید.
برخی بر این باورند که کد باید مستند و کامنت ها باید کم باشند. با این حال ، کاملا با آن مخالفیم(این نظر شخصی ماست). مشکلی در استفاده از کامنت ها برای توضیح الگوریتم های پیچیده ، regex یا سناریوها وجود ندارد.
از نظرات برای توضیح “چرا” به جای “چگونه” استفاده کنید.