Javadoc
سلام؛
این مقاله به تدریج تکمیل خواهد شد. با رعایت مطالب این مقاله خواهیم توانست کد بهتری بنویسیم. ضمنا از مشارکت دوستان استقبال می کنم.
چکیده
یکی از خصوصیات زبان برنامه نویسی جاوا، Javadoc است. Javadoc روشی برای مستندسازی کدهای شماست. حتما شما هم در فیلم های تدریس استاد دیده اید که وقتی آقای آقاجانی نام تابعی را تابپ می کند، توضیحات مفصلی درباره تابع و تک تک پارامترهای آن ظاهر می شود. منظور از مستندسازی چنین چیزی است. توصیه می شود «هر» متدی که می نویسید را مستند کنید. این «هر» شامل متد های Public و protected و حتی private می شود.
چگونه در ایکلیپس Javadoc بنویسیم؟
خوشبختانه ایکلیپس نیمی از زحمات را به صورت اتوماتیک می کشد. برای اضافه کردن Javadoc در حالی که کرسر روی متد مورد نظر است، کلیدهای SHIFT + ALT + J را فشار دهید. کدهای خاکستری رنگ Javadoc بالای متد اضافه می شود.
نگاهی دقیقتر به اجزای Javadoc
نکاتی برای بهتر نوشتن Javadoc
پاسخگویی و مشاهده پاسخ های این سوال تنها برای اعضای ویژه سایت امکان پذیر است .
چنانچه تمایل دارید به همه بخش ها دسترسی داشته باشید میتوانید از این بخش لایسنس این آموزش را خریداری نمایید .
