Kommentare Java-Dokumentation
Java-Annotationen nur drei Arten von Möglichkeiten. Die ersten beiden sind // und / * * /, und die dritte ist die Legende Kommentar genannt, die mit * / mit / **, Ende beginnt.
Beschreibung Kommentar können Sie Informationen über das Programm in das Programm einbinden. Sie können die javadoc Tool verwenden, um Informationen und Ausgabe in HTML-Dateien erzeugen.
Beschreibung Kommentar, Sie weitere Informationen in Bezug auf Ihr Programm aufzunehmen.
javadoc-Tag
javadoc Tool erkennt die folgenden Tags:
| Etikett | Beschreibung | Beispiel |
|---|---|---|
| @author | Identifiziert eine Klasse von Autoren | @author Beschreibung |
| @deprecated | ein Mitglied der Klasse mit dem Namen oder verfallen | @deprecated Beschreibung |
| {@docRoot} | Pfad angegeben in der aktuellen Dokumentstammverzeichnis | Verzeichnispfad |
| @exception | Markieren Sie eine Klasse Ausnahmen geworfen | @exception Ausnahmename Erklärung |
| {@inheritDoc} | Direkt von der übergeordneten Klasse erbt Kommentar | Erbt ein Kommentar aus der unmittelbaren surperclass. |
| {@link} | Einfügen eines Links zu einem anderen Thema | {@link Namens text} |
| {@linkplain} | Setzen Sie einen Link zu einem anderen Thema, aber der Link wird im Klartext Schriftart angezeigt | Fügt ein Inline-Link zu einem anderen Thema. |
| @param | Beschreibung eines Verfahrensparameters | @param Parametername Erklärung |
| @return | Rückgabetyp Beschreibung | @return Erklärung |
| @see | Gibt einen Link zu einem anderen Thema | @see Anker |
| @serial | Eine Beschreibung der Abfolge der Eigenschaft | @serial Beschreibung |
| @serialData | Beschreibung Methode geschrieben von write () und writeExternal () Daten | @serialData Beschreibung |
| @serialField | Eine Beschreibung der Komponenten ObjectStreamField | @serialField Name Typ Beschreibung |
| @since | Wenn ein spezifischer Marker der Änderung der Einführung | @since Release |
| @throws | Und @exception gleichen Label. | Das @ throws-Tag hat die gleiche Bedeutung wie der @exception-Tag. |
| {@value} | Display Wert einer Konstante, muß die Konstante eine statische Eigenschaft sein. | Zeigt den Wert einer Konstante, die ein statisches Feld sein muß. |
| @version | Version der angegebenen Klasse | @version info |
Dokumentation Kommentare
Nach dem Start / **, ist die erste Zeile oder Zeilen der Haupt Beschreibung von Klassen, Variablen und Methoden.
Danach können Sie einen oder mehrere von was-Tag sortiert von @. @ Jeder Tag auf einer neuen Zeile stehen muss, oder am Anfang einer Zeile mit einem Sternchen (*) beginnen, gefolgt.
Eine Mehrzahl von der gleichen Art von Etikett sollte in eine Gruppe platziert werden. Zum Beispiel, wenn Sie drei @see Tags haben, können sie durch eine zusammengestellt sein.
Es folgt eine Beschreibung eines Beispiels einer Klasse Kommentar:
/*** This class draws a bar chart. * @author Zara Ali * @version 1.2 */
Was für javadoc Ausgang
javadoc-Tool Java-Programm den Quellcode als Eingabe, Ausgabe einige HTML-Datei Ihr Programm Anmerkungen enthält.
Jede Art von Informationen in der HTML-Datei allein. javadoc Ausgang kann auch Baum und Indizes vererbt werden.
Aufgrund der unterschiedlichen javadoc Umsetzungsarbeiten verschieden sein können, müssen Sie die Version Ihrer Java-Entwicklungssystem und andere Details zu überprüfen, die entsprechende Version von Javadoc wählen.
Beispiele
Im Folgenden ist ein Kommentar, der die Verwendung eines einfachen Beispiels erläutert. Beachten Sie, dass das vorherige Projekt jede Anmerkung in seiner Beschreibung.
Nach javadoc Behandlung wird SquareNum Klasse Noten im SquareNum.html finden.
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);
}
}
Wie folgt, um das javadoc-Tool bearbeiten SquareNum.java Datei:
$ 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
$