آموزش کامنت ها در جاوا (به زبان کاملا ساده)

در این آموزش با کامنت ها در جاوا و چرایی و نحوه استفاده از آنها آشنا می شوید.

در برنامه نویسی ، نظرات بخشی از برنامه در نظر گرفته می شوند که برای درک کد استفاده می شوند و توسط کامپایلرهای جاوا کاملا نادیده گرفته شده و اجرا نمی شوند.

در زبان برنامه نویسی جاوا ، دو نوع کامنت وجود دارد:

• /* … */
• // ….

کامنت مرسوم /*…….*/

این یک کامنت چند خطه است که می تواند چندین خطه باشد. کامپایلر جاوا همه چیز را از /* تا */ نادیده می گیرد. مثلا،

1. /* This is a multi-line comment.
2. * The problem prints “Hello, World!” to the standard output.
3. */
4. class HelloWorld {
5. public static void main(String[] args) {
6. {
7. System.out.println(“Hello, World!”);
8. }
9. }
10. }

در کد بالا کامنت برابر است با:

/* This is a multi-line comment.

* The problem prints “Hello, World!” to the standard output.

*/

کامنت یک خطه //

کامپایلر همه چیز را از // تا انتهای خط نادیده می گیرد. مثلا،

1. // “Hello, World!” program
3. class AssignmentOperator {
4. public static void main(String[] args) {
5. {
6. System.out.println(“Hello, World!”); // prints “Hello, World!”
7. }
8. }
9. }

برنامه فوق شامل دو کامنت یک خطه است:

جاوا، جاوا اسکریپت رو قورت بده! بدون کلاس، سرعت 2 برابر، ماندگاری 3 برابر، پولسازی عالی با توسعه وب، ماشین لرنینگ و ... کتابخانه های پیشرفته جاوا اسکریپت و ... دانلود:

پک کامل جاوا اسکریپت  پک آموزش Node.js  پک React.js

پک کامل جاوا

پک مبانی برنامه نویسی (اختیاری-مکمل)

// “Hello, World!” program

و

// prints “Hello, World!”

از کامنت ها در راه درست استفاده کنید

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

برخی بر این باورند که کد باید مستند و کامنت ها باید کم باشند. با این حال ، کاملا با آن مخالفیم(این نظر شخصی ماست). مشکلی در استفاده از کامنت ها برای توضیح الگوریتم های پیچیده ، regex یا سناریوها وجود ندارد.

از نظرات برای توضیح “چرا” به جای “چگونه” استفاده کنید.

ترفندهای کامنت ها در جاوا 

کامنت‌ها در جاوا نه تنها برای توضیح قسمت‌های کد استفاده می‌شوند، بلکه می‌توانند برای انجام برخی ترفندها و کارهای مفید نیز به کار گرفته شوند. در زیر چند ترفند مرسوم با کامنت‌ها در جاوا را مشاهده می‌کنید:

1. غیرفعال کردن یک بخش از کد: می‌توانید کد را با قرار دادن علامت کامنت در ابتدا و انتهای بخشی از آن غیرفعال کنید. این کار به‌عنوان یک روش موقت برای حذف یا غیرفعال کردن بخشی از کد بدون حذف آن برای استفاده‌های آینده مفید است.

    مثال:

    /*

    int x = 5;

    System.out.println(x);

    */

2. استفاده برای ایجاد توضیحات زمان اجرا (Runtime Comments): با قرار دادن کامنت‌ها در کد می‌توانید اطلاعات مفیدی را در زمان اجرا نمایش دهید. برای مثال، می‌توانید مقادیر مختلف متغیرها یا وضعیت‌های مختلف برنامه را در هنگام اجرا با استفاده از کامنت‌ها نمایش دهید.
3. استفاده از کامنت‌ها برای ایجاد شمای برنامه (Program Skeleton): می‌توانید با استفاده از کامنت‌ها یک شمای کلی از برنامه را ایجاد کنید و سپس کد را درون آن قرار دهید. این کار می‌تواند به شما کمک کند تا قبل از شروع نوشتن کد، یک نقشه راه واضح از برنامه خود داشته باشید.
4. استفاده برای ایجاد منوهای راهنما (Menu Comments): اگر برنامه‌ای با واسط کاربری گرافیکی دارید، می‌توانید کامنت‌ها را برای ایجاد منوها و راهنمایی برای کاربران استفاده کنید تا آن‌ها را در استفاده از برنامه‌تان راهنمایی کنید.
5. نشان دادن وضعیت کد (Code Status): می‌توانید با استفاده از کامنت‌ها وضعیت کد را نشان دهید، از جمله وضعیت‌هایی مانند "TO-DO" برای بخش‌هایی از کد که هنوز باید تکمیل شوند، "FIXME" برای بخش‌هایی که نیاز به اصلاح دارند و "DONE" برای بخش‌هایی که کاملاً تکمیل شده‌اند.

این ترفندها نشان می‌دهند که کامنت‌ها در جاوا نه تنها برای توضیح قسمت‌های کد مفیدند، بلکه می‌توانند برای انجام کارهای مختلف و ارائه اطلاعات مفید به برنامه‌نویس یا کاربر نیز مورد استفاده قرار گیرند.