Das Javadoc-Tool verwendet den Quellcode Ihres Java-Programms als Eingabe und gibt einige HTML-Dateien mit Kommentaren zu Ihrem Programm aus.
Die Informationen für jede Klasse befinden sich in einer separaten HTML-Datei. Javadoc kann auch geerbte Baumstrukturen und Indizes ausgeben.
Da die Implementierung von Javadoc unterschiedlich ist, kann auch die Arbeit unterschiedlich sein. Sie müssen die Version Ihres Java-Entwicklungssystems und andere Details überprüfen, um die geeignete Javadoc-Version auszuwählen.
Beispiel
Das Folgende ist ein einfaches Beispiel für die Verwendung von Beschreibungskommentaren. Beachten Sie, dass jeder Kommentar vor dem Element steht, das er beschreibt.
Nach der Verarbeitung durch Javadoc werden die Kommentare der SquareNum-Klasse in SquareNum.html gefunden.
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
$ Das Obige ist das erweiterte Java-Tutorial: Was das Javadoc ausgibt. Weitere verwandte Inhalte finden Sie auf der chinesischen PHP-Website (www.php.cn).
