جافا الوثائق تعليقات

جافا شروح فقط ثلاثة أنواع من الطرق. الأولين هي // و/ * * / والثالث ويسمى التعليق أسطورة أن يبدأ / **، مع نهاية * /.

وصف تعليق يسمح لك بإضافة معلومات عن البرنامج في البرنامج. يمكنك استخدام أداة جافادوك لتوليد المعلومات والإخراج إلى ملفات HTML.

وصف تعليق، يمكنك تسجيل مزيد من المعلومات حول البرنامج.

العلامة جافادوك

تعترف أداة جافادوك العلامات التالية:

وثائق تعليقات

بعد بدء / **، السطر الأول أو خطوط هو الوصف الرئيسي من الطبقات، والمتغيرات والأساليب.

بعد ذلك، يمكنك تضمين واحد أو أكثر من ما يفرز من @ العلامة. @ يجب أن يكون كل علامة على سطر جديد، أو تبدأ في بداية خط تليها علامة النجمة (*).

يجب أن توضع وافر من نفس النوع من التسمية في مجموعة. على سبيل المثال، إذا كان لديك ثلاث علاماتsee، فإنها يمكن أن توضع معا واحدا تلو الآخر.

ما يلي هو وصف لمثال على تعليق الطبقة:

/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/

ما الإخراج جافادوك

أداة جافادوك شفرة المصدر برنامج جافا الخاص بك كما المدخلات والمخرجات بعض الملفات HTML تحتوي على شروح البرنامج.

ولكل نوع من المعلومات يكون وحده في ملف HTML. ويمكن أيضا أن الناتج جافادوك تكون موروثة شجرة والفهارس.

ويرجع ذلك إلى العمل المختلفة تنفيذ جافادوك قد تكون مختلفة، تحتاج إلى التحقق من إصدار نظام تطوير جافا الخاصة بك وغيرها من التفاصيل، حدد الإصدار المناسب من جافادوك.

أمثلة

ما يلي هو التعليق الذي يفسر استخدام مثال بسيط. لاحظ أن المشروع السابق كل الشرح في وصفه.

بعد العلاج جافادوك، سيتم العثور على الملاحظات الطبقة SquareNum في SquareNum.html.

import java.io.*;
 
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a double.
   * @exception IOException On input error.
   * @see IOException
   */
   public double getNumber() throws IOException {
      InputStreamReader isr = new InputStreamReader(System.in);
      BufferedReader inData = new BufferedReader(isr);
      String str;
      str = inData.readLine();
      return (new Double(str)).doubleValue();
   }
   /**
   * This method demonstrates square().
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {
      SquareNum ob = new SquareNum();
      double val;
      System.out.println("Enter value to be squared: ");
      val = ob.getNumber();
      val = ob.square(val);
      System.out.println("Squared value is " + val);
   }
}

على النحو التالي، وذلك باستخدام أداة جافادوك لمعالجة ملف SquareNum.java:

$ javadoc SquareNum.java
Loading source file SquareNum.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_13
Building tree for all the packages and classes...
Generating SquareNum.html...
SquareNum.java:39: 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...
Generating stylesheet.css...
1 warning
$