در آموزش‌های گذشته به بررسی انواع روش‌های کامنت‌گذاری در برنامه‌نویسی و به خصوص زبان جاوا پرداختیم و گفتیم که کامنت‌ها هیچ تأثیری در روند اجرای برنامه ندارند که در این آموزش قصد داریم تا به صورت دقیق‌تر با روش‌های مختلف کامنت‌گذاری آشنا شده و برخی مزایای استفاده از کامنت در کدنویسی را بیان کنیم.

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

آشنایی با کامنت‌گذاری چندخطی

روش اول تحت عنوان کامنت‌گذاری چندخطی شناخته می‌شود بدین صورت که چنانچه بخواهیم چند خط از کد خود را از دید کامپایلر پنهان سازیم، در ابتدای خط اول از کد مد نظر خود علائم */ و در انتهای خط آخر از آن هم علائم /* را قرار می‌دهیم و بدین ترتیب هر آنچه که مابین این علائم قرار گیرد جزو کامنت‌ها محسوب می‌شود:

public class HelloWorld {
    /*
    * This is a multi-line comment for you!
    */
    public static void main(String[] args) {
        String text = "In the name of God";
        System.out.println(text);
    }
}

همچنین توجه داشته باشیم که قرار دادن علامت ستاره برای خطوط میانی دلخواه بوده و همان‌طور که در کد فوق مشاهده می‌کنید، نرم‌افزار اکلیپس به صورت پیش‌فرض برای خطوط میانی علامت * قرار داده است.

هشدار

کامنت‌های چندخطی را نمی‌توان درون یک کامنت چندخطی دیگر قرار داد چرا که در این صورت اجرای برنامه با مشکل مواجه می‌شود.

آشنایی با کامنت‌های پایان خط

روش دوم به منظور کامنت‌گذاری مربوط به کامنت‌های پایان خط می‌باشد و در صورتی از این روش جهت کامنت گذاشتن در کدنویسی استفاده می‌شود که بخواهیم در انتهای خطی از سورس‌کد خود مطلبی را به منظور یادآوری بنویسیم که برای این منظور نیز از علائم // استفاده می‌کنیم. مثالی از این نوع کامنت‌گذاری را در کد زیر مشاهده می‌کنیم:

public class HelloWorld {
    public static void main(String[] args) {  // This is a method
        String text = "In the name of God";
        System.out.println(text);
    }
}

روش کامنت‌گذاری با استفاده از علائم // را می‌توانیم در پروسۀ دیباگ کردن سورس‌کد نیز به کار بگیریم بدین صورت که نشانگر ماوس خود را روی بخشی از سورس‌کد قرار می‌دهیم که به نظر می‌رسد موجب ایجاد مشکل در حین اجرای برنامه شده است سپس دکمه‌های / + Ctrl را فشار می‌دهیم و در ادامه می‌بینیم که بخش مورد نظر از سورس‌کد کامنت شده و به رنگ متفاوتی در می‌آید. حال برنامه را مجدد کامپایل می‌کنیم تا ببینیم ارور آن رفع شده است یا خیر که در صورت برطرف شدن مشکل می‌توان گفت که ارور مربوطه در بخش کامنت‌شده از سورس‌کد می‌باشد و در غیر این صورت مجدد کلیدهای / + Ctrl را فشار می‌دهیم تا کد مد نظر از حالت کامنت خارج شود. در ادامه، فرآیند فوق‌الذکر را برای بخش دیگری از سورس‌کد تکرار می‌کنیم تا زمانی که ارور موجود را شناسایی کنیم (اگر چه این نوع کامنت‌ها به کامنت‌های پایان خط معروف هستند، اما می‌توان آن‌ها را در ابتدای یک خط از کد نیز مورد استفاده قرار داد.)

آشنایی با کامنت‌هایی از جنس javadoc

روش سوم کامنت‌گذاری از نوع کامنت‌های javadoc می‌باشد بدین صورت که در ابتدا و انتهای خطوط مورد نظر از سورس‌کد خود به ترتیب علائم **/ و /* را درج کرده و توضیحاتی را داخل این بخش از سورس‌کد یادداشت می‌کنیم. در واقع، چنین کامنت‌هایی برای کسانی مفید خواهند بود که در آینده کامنت‌های درج‌شده به روش javadoc را مطالعه می‌کنند و از قضا دانش کمی در رابطه با زبان برنامه‌نویسی جاوا دارند که برای این منظور نیز از کلیۀ کامنت‌های javadoc خروجی اچ‌تی‌ام‌ال گرفته شده و در قالب یک صفحۀ وب در اختیار علاقه‌مندان قرار می‌گیرد (نحوۀ ایجاد خروجیِ اچ‌تی‌ام‌ال از کامنت‌های javadoc خارج از حوصلۀ این آموزش بوده لذا از توضیح در این باره خودداری می‌کنیم.) در ادامه به منظور درک بهتر نحوۀ کامنت‌گذاری از نوع کامنت‌های javadoc کد زیر را مد نظر قرار می‌دهیم:

public class HelloWorld{
    /**
    * This is a javadoc comment for you!
    */
    public static void main(String[] args) {
        String text = "In the name of God";
        System.out.println(text);
    }
}

همان‌طور که در کد فوق می‌بینید، بخش مورد نظر از سورس‌کد را با علائمی به صورت **/ و /* کامنت کرده‌ایم که منجر به تغییر رنگ آن‌ها گردیده است.

نگاهی به کامنت‌گذاری در زبان برنامه‌نویسی جاوا