Java เอกสารความคิดเห็น

Java คำอธิบายประกอบเพียงสามชนิดของวิธี สองคนแรกเป็น // และ / * * / และคนที่สามเรียกว่าตำนานความคิดเห็นที่ขึ้นต้นด้วย / ** ลงท้ายด้วย * /

รายละเอียดความคิดเห็นที่ช่วยให้คุณสามารถฝังข้อมูลเกี่ยวกับโปรแกรมในโปรแกรม คุณสามารถใช้เครื่องมือ Javadoc ในการสร้างข้อมูลและส่งออกไปยังไฟล์ HTML

รายละเอียดความคิดเห็นคุณบันทึกข้อมูลเพิ่มเติมเกี่ยวกับโปรแกรมของคุณ

แท็ก Javadoc

เครื่องมือ Javadoc ตระหนักถึงแท็กต่อไปนี้:

เอกสารความคิดเห็น

หลังจากที่เริ่มต้น / ** บรรทัดแรกหรือเส้นเป็นคำอธิบายที่หลักของการเรียนตัวแปรและวิธีการ

หลังจากนั้นคุณสามารถรวมหนึ่งหรือมากกว่าของสิ่งที่ประเภทของแท็ก @ @ แท็กแต่ละคนจะต้องอยู่ในบรรทัดใหม่หรือเริ่มต้นที่จุดเริ่มต้นของเส้นตามด้วยเครื่องหมายดอกจัน (*)

ใหญ่ของชนิดเดียวกันของฉลากควรจะอยู่ในกลุ่ม ตัวอย่างเช่นถ้าคุณมีสามแท็ก @see พวกเขาสามารถใส่กันหนึ่งโดยหนึ่ง

ต่อไปนี้เป็นคำอธิบายของตัวอย่างของการแสดงความคิดเห็นคลาส A:

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

อะไร Javadoc เอาท์พุท

เครื่องมือ Javadoc รหัสแหล่งโปรแกรม Java ของคุณเป็นนำเข้าส่งออกบางไฟล์ HTML ที่มีคำอธิบายประกอบโปรแกรมของคุณ

ประเภทของข้อมูลที่แต่ละคนจะได้อยู่คนเดียวในไฟล์ HTML เอาท์พุท Javadoc ยังสามารถสืบทอดต้นไม้และดัชนี

เนื่องจากการทำงานของการดำเนินงานที่แตกต่างกัน Javadoc อาจจะแตกต่างกันคุณต้องตรวจสอบรุ่นของระบบการพัฒนา Java ของคุณและรายละเอียดอื่น ๆ ให้เลือกรุ่นที่เหมาะสม Javadoc

ตัวอย่าง

ต่อไปนี้เป็นความคิดเห็นที่อธิบายถึงการใช้ตัวอย่างง่ายๆที่ โปรดทราบว่าโครงการที่ผ่านมาแต่ละคำอธิบายประกอบในคำอธิบาย

หลังจากการรักษา Javadoc บันทึกระดับ 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);
   }
}

ดังต่อไปนี้โดยใช้เครื่องมือ Javadoc ในการประมวลผลไฟล์ 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
$