مشخصات مقاله
-
1809
-
0.0
-
3611
-
0
-
0
آموزش Java – تعریف Documentation API (توابع مستندسازی) و استفاده از ابزار javadoc در Java
آموزش Java – تعریف Documentation API (توابع مستندسازی) و استفاده از ابزار javadoc در جاوا
می توان به کمک ابزار javadoc توابعی کتابخانه ای جهت مستندنویسی و توضیح کدبرنامه ی خود تعریف کرد. برای توضیح کد خود در فایل های جاوا کافی است متن توضیح کد را داخل کاراکترهای /**... */ قرار دهید. با این روش می توانید به راحتی برای کامپوننت های مختلف کد و برنامه ی خود نظیر کلاس، متد، constructor (تابع سازنده)، فیلدها و متغیرها را کامنت درج نمایید.
در زیر یک کلاس ساده را می بینید که کامنت مستندسازی و توضیح کد را شامل می شود.
1 2 3 4 5 6 7 | package com.abc; /** This class is a user-defined class that contains one methods cube.*/ public class M{ /** The cube method prints cube of the given number */ public static void cube(int n){System.out.println(n*n*n);} } <button></button> |
به منظور ایجاد توابع کتابخانه ای مستندسازی (Document API)، کافی است در پنجره ی فرمان (command prompt) ابزار javadoc و به دنبال آن اسم فایل java را درج نمایید. لزومی ندارد javafile را کامپایل نمایید.
دستور تعریف توابع کتابخانه ای Javadoc به شرح زیر می باشد:
1 | javadoc M.java<button></button> |
فایل های javadoc با فرمت html تعریف می شوند. پس از اجرای دستور فوق، می بینید که تعداد زیادی فایل html ایجاد شده که حاوی اطلاعات مربوط به کاربرد کلاس ها، متدها، interface ها و غیره ... می باشد. جهت مشاهده ی اطلاعات مربوط به کلاس ها، فایل index.html را باز نمایید.