نظرات در جاوا

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

راه های برجسته کردن نظرات

جاوا دو راه برای برجسته کردن نظرات در متن دارد.

نظر پیاده سازی (نظر کد)

1. نظر دادن یک خط

   این رایج ترین نوع کامنت مورد استفاده است. برای نوشتن چنین نظری، باید از دو اسلش رو به جلو استفاده کنید //. در این حالت کامنت بلافاصله بعد از کاراکترها شروع می شود //و تا آخر خط ادامه می یابد.

   System.out.println("Hello, Java world!");
   // наш комментарий

2. نظر دادن یک بلوک متن

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

   /*
    Пример простой программы на Java
   */
   
   public class SampleProgram
   {
    public static void main (String [] args)
    {
    System.out.println("Hello, Java world!");
    }
   }

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

مستندسازی نظر

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

/**
* Метод возвращает максимальное meaning
* из трех переданных аргументов
* @param a - первый параметр
* @param b - второй параметр
* @param c - третий параметр
* @return - максимальный из параметров
*/
public int max(int a, int b, int c) {
   return Math.max(Math.max(a, b), c);
}

چه چیز دیگری برای خواندن؟ به عنوان مثال، این مطالب: نظرات در جاوا: همه چیز به این سادگی نیست . یا یک سخنرانی از جستار Java Syntax Pro درباره نظرات.