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

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

class FirstProgram {
    /*
    * 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);
    }
}

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

نوع دوم از کامنت ها به کامنت های پایان خط معروف هستند. در واقع چنانچه در انتهای خطی که کدی را در آن نوشته ایم بخواهیم جهت یادآوری خود چیزی بنویسیم، از این نوع کامنت با قرار دادن علامت های // استفاده خواهیم کرد. مثالی از این کامنت را در کد زیر مشاهده خواهید کرد:

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

آنچه در مورد این نوع از کامنت ها بسیار جالب توجه است این است که چنانچه بخشی از برنامه شما دچار مشکل باشد و شما به اصطلاح بخواهید برنامه را Debug کنید، می توانید از این کامنت استفاده کنید به این صورت که نشانگر موس خود را روی بخشی از کد که تصور می کنید مشکل زا است قرار داده، سپس دکمه Ctrl و علامت / فشار دهید. خواهید دید که آن بخش از کد شما کامنت شده و به رنگ متفاوتی در خواهد آمد. حال می توانید برنامه را مجدد کامپایل کنید و ببینید که آیا مشکل رفع شده است یا خیر. چنانچه مشکل رفع شده بود متوجه خواهید شد که آن بخشی از کد که کامنت شده است دارای مشکل است پس نیاز است که آن را رفع نمایید. چنانچه رفع نشده بود مجدداً با انتخاب آن بخش از کد دکمه Ctrl و علامت / را فشار دهید تا از حالت کامنت درآید و این کار را می توانید برای مابقی بخش های سورس کد خود تا زمانی انجام دهید که مشکل برنامه خود را پیدا نمایید (اگر چه این نوع کامنت ها تحت عنوان کامنت های پایان خط معروف هستند، اما ما می توانیم آن ها را در ابتدای یک خط از کد نیز مورد استفاده قرار دهیم.)

نوع سوم از کامنت ها از نوع javadoc می باشند به این معنی که با قرار دادن علامت **/ در ابتدای خطی که تمایل داریم به کامنت تبدیل شود و قرار دادن علامت /* در انتهای خطی که کامنت ما به پایان می رسد، ما توضیحاتی را داخل سورس کد خود درج می کنیم که برای کسانی که می خواهند کد ما را در آینده مطالعه کنند ولی دانش زبان جاوا ندارند بسیار مفید خواهد بود به این صورت که از کلیه کامنت های برنامه خود که از نوع javadoc هستند خروجی HTML می گیریم و کلیه کامنت ها به صورت یک صفحه وب در اختیار علاقمندان قرار می گیرند (نحوه ایجاد javadoc برای برنامه نویسان مبتدی ضروری نیست بنابراین از توضیح در این باره خودداری می شود!)

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

در آموزش بعدی با انواع متغیرها در زبان برنامه نویسی جاوا و نحوه اختصاص مقدار به آن ها و سایر مباحث مربوطه آشنا خواهیم شد.