اضافه کردن کامنت به کلاس ها در جاوا

در این مقاله، به بررسی نحوه ی ایجاد انواع کامنت ها در زبان برنامه نویسی جاوا می پردازیم.  

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

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

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

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

کامنت ها، همچنین هنگامی که شما در حال ایجاد یک اپلیکیشن هستید، کاربرد دارند. مثلاً اگر که برنامه ی شما به درستی کار نکند، شما می توانید برخی از کدها را به کامنت تبدیل کنید، و سپس به کرات برنامه را اجرا کنید تا تاثیر را مشاهده کنید. هنگامی که شما یک عبارت دستوری را به کامنت تبدیل می کنید، دیگر کامپایلر به آن عبارت به چشم کد یا دستور نگاه نمی کند و در هنگام اجرا، آن را نادیده می گیرد. و JVM( ماشین مجازی جاوا) دستور داخل آن کامنت را اجرا نمی کند. 

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

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

2. کامنت های بلوکی: این نوع کامنت ها با استفاده از یک اسلش و ستاره(*/) شروع شده و با استفاده از یک ستاره اسلش(/*) پایان می یابد. یک کامنت بلوکی می تواند در یک خط قرار گیرد و یا چند خط را اشغال کند.   

3. کامنت های Javadoc: این نوع کامنت ها، کامنت های خاصی هستند که به صورت بلوکی می باشند. این نوع کامنت ها با یک اسلش و دو ستاره(**/) شروع می شوند و به وسیله ی علامت ستاره اسلش(/*) پایان می یابند. شما می توانید از کامنت های Javadoc برای تولید مستندات به وسیله ی یک برنامه به نام javadoc استفاده کنید. در ضمیمه ی E، می توانید نحوه ی ایجاد کامنت های javadoc را مشاهده کنید. 

نکته: معمولا علامت اسلش(/) با علامت بک اسلش(\) اشتباه گرفته می شود. باید توجه داشت که این دو علامت با یکدیگر متفاوت هستند. و نمی توانید آنها را به جای یکدیگر استفاده کنید. 
نکته: بسته ی توسعه ی جاوا(JDK) شامل ابزار javadoc می باشد که شما می توانید از آن به هنگام نوشتن برنامه ها در جاوا، استفاده کنید. این ابزار صفحات HTML ای را تولید می کند که کلاس ها و محتوای آنها را توضیح می دهند. 

عکس 1.9 نشان می دهد که چگونه از کامنت ها در کدها استفاده کنیم. در این مثال، تنها عبارتی که اجرا می شود، عبارت ;("System.out.println("Hello است و بقیه ی چیزها همه کامنت محسوب می شوند. 

دو گزینه ی صحیح و یک گزینه ی غلط

موضوع: اضافه کردن کامنت به یک کلاس جاوا

1. کامنت های خطی با دو علامت اسلش(//) شروع می شوند و به وسیله ی دو علامت بک اسلش پایان می یابند. همچنین این نوع کامنت ها می توانند در چندخط گسترده شوند. 

2. کامنت های بلوکی، با علامت اسلش ستاره(*/) شروع می شوند و به وسیله ی یک ستاره اسلش(/*) پایان می یابند. این نواع کامنت ها می توانند در هر تعداد خط، گسترده شوند. 

3. کامنت های Javadoc با یک علامت اسلش و دوستاره (**/) شروع می شوند و به وسیله ی یک علامت ستاره اسلش(/*) پایان می یابند. از این نوع کامنت ها برای ایجاد مستندات به وسیله ی یک برنامه به نام javadoc استفاده می شود. 

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

• قبلی
• بعدی