مقدمه
با عرض سلام و وقت بخیر خدمت کاربران سایت پی وی لرن. و کاربرانی که دوره کامل آموزش برنامه نویسی جاوا را دنبال می کنند. تمام زبان های برنامه نویسی محبوب و قدرتمند در دنیا به برنامه نویس امکان افزودن نظرات و یا توضیحاتی در داخل کدهای نوشته شده را می دهد. این توضیحات در قالب یک کاراکتر خاص قرار گرفته که باعث می شود کامپایلر از کامپایل و اجرای آن ها صرفه نظر کند. جاوا نیز به عنوان محبوب ترین زبان برنامه نویسی دنیا این قابلیت ساده را برای برنامه نویسان فراهم کرده است شما می توانید با استفاده از گذاشت کامنت در جاوا توضیحات لازم را در مورد بخشی از کدهای مورد نظر خود قرار دهید. برای آشنایی بیشتر با توضیحات در جاوا در ادامه ی مباحث این بخش با ما همراه باشید.
آشنایی با توضیحات در جاوا
در ادامه ی مباحث آشنایی با توضیجات در جاوا ، ما شما را با ساختار و انواع کامنت در جاوا آشنا خواهیم کرد.
زبان جاوا سه نوع کامنت را پشتیبانی می کند :
| ردیف | کامنت و توضیحات مربوط به آن |
|---|
| ۱ | /* text */ /* کامپایلر از کامپایل کردن کد قرار گرفته در این قالب صرفه نظر می کند.*/ |
| ۲ | //text کد و توضیحاتی که بعد از کاراکترهای // قرار بگیرد کامپایل نمی شود. |
| ۳ | /** documentation */ ابزار JADK Javadoc از توضیحات doc برای استفاده می کند |
در ادامه ی این آموزش مباحث لازم را برای کار با Javadoc قرار داده ایم.
Javadoc چیست ؟
Javadoc یک ابزار است که با JDK همراه است و برای تولید مستندات کد جاوا در قالب HTML از کد منبع جاوا استفاده می کند.
مثال زیر نمونه ای از درج توضیحات را در قالب /*….*/ نشان می دهد:
مثال :
| /** * The HelloWorld program implements an application that * simply displays "Hello World!" to the standard output. * * @author Zara Ali * @version 1.0 * @since 2014-03-31 */ public class HelloWorld { public static void main(String[] args) { /* Prints Hello, World! on standard output. System.out.println("Hello World!"); } } |
شما می توانید تگ های HTML مورد نیاز را در قسمت توضیحات قرار دهید.
به عنوان مثال، مثال زیر از <h1> …. </ h1> استفاده می کند و از <p> نیز برای ایجاد پاراگراف استفاده می کند:
مثال :
مثال :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | /** * <h1>Hello, World!</h1> * The HelloWorld program implements an application that * simply displays "Hello World!" to the standard output. * <p> * Giving proper comments in your program makes it more * user friendly and it is assumed as a high quality code. * * * @author Zara Ali * @version 1.0 * @since 2014-03-31 */ public class HelloWorld { public static void main(String[] args) { /* Prints Hello, World! on standard output. System.out.println("Hello World!"); } } |
تگ های javadoc
ابزار javadoc تگ های زیر را شناسایی می کند :
| تگ | توضیحات | ساختار |
|---|
| @author | نویسنده یک کلاس را اضافه می کند. | @author name-text |
| {@code} | نمایش متن در فونت کد بدون تفسیر متن به عنوان نشانه گذاری html. | {@code text} |
| {@docRoot} | مسیر نسبی به ریشه دایرکتوری ایجاد شده از هر صفحه تولید شده را نشان می دهد. | {@docRoot} |
| @deprecated | یک کامنت اضافه می کند که نشان می دهد این API دیگر نباید استفاده شود. | @deprecated deprecatedtext |
| @exception | یک زیرپوشه Throws را به مستندات تولید شده با نام کلاس و متن توصیف می افزاید. | @exception class-name description |
| {@inheritDoc} | مفاهیم را از کلاس نزدیکترین پیمانه یا اینترفیس قابل اجرا به ارث می برد. | Inherits a comment from the immediate surperclass. |
| {@link} | یک پیوند درون خطی را با برچسب متن قابل مشاهده قرار می دهد. | {@link package.class#member label} |
| {@linkplain} | به غیر از تگ لینک بقیه در متن ساده نمایش داده می شود. | {@linkplain package.class#member label} |
| @param | یک پارامتر با نام پارامتر مشخص شده و سپس توضیح مشخص شده را به قسمت Parameters اضافه می کند. | @param parameter-name description |
| @return | یک “Returns” را به بخش متن توضیحات اضافه می کند. | @return description |
| @see | عنوان “See Also” را اضافه می کند با یک پیوند یا متن که اشاره به مرجع دارد. | @see reference |
| @serial | به طور پیش فرض برای یک فیلد serializable مورد استفاده در توضیحات doc است. | @serial field-description | include | exclude |
| @serialData | داده های نوشته شده توسط متد ()writeObject یا ()writeExternal نوشته می شود. | @serialData data-description |
| @serialField | یک جزء ObjectStreamField را مستند می کند. | @serialField field-name field-type field-description |
| @since | عنوان “Since” را با مشخص شده از متن به مستندات تولید اضافه می کند. | @since release |
| @throws | تگهایthrows و exception مترادف هستند. | @throws class-name description |
| {@value} | هنگامی که {value} در توضیح doc یک فیلد استاتیک مورد استفاده قرار می گیرد، مقدار آن ثابت را نمایش می دهد. | {@value package.class#field} |
| @version | یک گزینه “Version” را با متن مشخص شده به اسناد تولید اضافه می کند | @version version-text |
برررسی یک مثال
مثال – برای نمونه برنامه ای ایجاد می کنیم که از چند تگ مهم برای ایجاد کامنت یا توضیحات در جاوا استفاده می کند.
اسناد مربوط به کلاس AddNum در فایل HTML AddNum.html تولید می شود اما همزمان یک فایل اصلی با نام index.html نیز ایجاد می شود:
مثال :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | import java.io.*; /** * <h1>Add Two Numbers!</h1> * The AddNum program implements an application that * simply adds two given integer numbers and Prints * the output on the screen. * <p> * <b>Note:</b> Giving proper comments in your program makes it more * user friendly and it is assumed as a high quality code. * * @author Zara Ali * @version 1.0 * @since 2014-03-31 */ public class AddNum { /** * This method is used to add two integers. This is * a the simplest form of a class method, just to * show the usage of various javadoc Tags. * @param numA This is the first paramter to addNum method * @param numB This is the second parameter to addNum method * @return int This returns sum of numA and numB. */ public int addNum(int numA, int numB) { return numA + numB; } /** * This is the main method which makes use of addNum method. * @param args Unused. * @return Nothing. * @exception IOException On input error. * @see IOException */ public static void main(String args[]) throws IOException { AddNum obj = new AddNum(); int sum = obj.addNum(10, 20); System.out.println("Sum of 10 and 20 is :" + sum); } } |
حالا، فایل AddNum.java بالا را با استفاده از ابزار javadoc به صورت زیر پردازش کنید:
مثال :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | $ javadoc AddNum.java Loading source file AddNum.java... Constructing Javadoc information... Standard Doclet version 1.7.0_51 Building tree for all the packages and classes... Generating /AddNum.html... AddNum.java:36: warning - @return tag cannot be used in method with void return type. Generating /package-frame.html... Generating /package-summary.html... Generating /package-tree.html... Generating /constant-values.html... Building index for all the packages and classes... Generating /overview-tree.html... Generating /index-all.html... Generating /deprecated-list.html... Building index for all classes... Generating /allclasses-frame.html... Generating /allclasses-noframe.html... Generating /index.html... Generating /help-doc.html... 1 warning $ |
کلام آخر
همانطور که در مرور مباحث آموزش توضیحات در جاوا مشاهده کردید. جاوا کلاس ها و متدهای کاملی را برای درج انواع توضیحات و کامنت ها در کدهای نوشته شده در برنامه را ارائه می دهد. از این رو مباحث آخرین آموزش جاوا را به چگونگی درج کامنت در جاوا اختصاص دادیم
فروشگاه
فیلم های آموزشی
کتاب های آموزشی
مقالات آموزشی
وردپرس
سارا
با سلام لطفا کار با فایل هارو هم بگین
پی وی لرن
سلام
بله در برنامه قرار می دهیم.