English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية
Java unterstützt drei Arten von Kommentaren. Die ersten beiden sind // und /* */Drittes wird als Erklärungskommentar bezeichnet, er beginnt mit /** Anfang, mit */Ende.
Beschreibende Kommentare erlauben es Ihnen, Informationen über das Programm in das Programm einzubinden. Sie können das javadoc-Tool verwenden, um Informationen zu generieren und in HTML-Dateien auszugeben.
Beschreibende Kommentare, die es Ihnen ermöglichen, Ihre Programminformationen besser zu dokumentieren.
javadoc Werkzeug erkennt die folgenden Tags:
| Tag | Beschreibung | Beispiel |
|---|---|---|
| @author | Den Autor einer Klasse kennzeichnen. | @author description |
| @deprecated | Eine veraltete Klasse oder ein Mitglied nennen. | @deprecated description |
| {@docRoot} | Den Pfad der Wurzelverzeichnis des aktuellen Dokuments angeben. | Directory Path |
| @exception | Eine von einer Klasse ausgelöste Ausnahme kennzeichnen. | @exception exception-name explanation |
| {@inheritDoc} | Kommentare von der unmittelbaren Oberklasse geerbt. | Inherits a comment from the immediate surperclass. |
| {@link} | Einen Link zu einem anderen Thema einfügen. | {@link name text} |
| {@linkplain} | Einen Link zu einem anderen Thema einfügen, aber der Link wird in reinem Textformat angezeigt. | Inserts an in-line link to another topic. |
| @param | Ein Methodenparameter beschreiben. | @param parameter-name explanation |
| @return | Beschreibt den Rückgabetyp. | @return explanation |
| @see | Einen Link zu einem anderen Thema angeben. | @see anchor |
| @serial | Beschreibt eine Serialisierungseigenschaft. | @serial description |
| @serialData | Beschreibt die Daten, die durch die Methoden writeObject() und writeExternal() geschrieben werden. | @serialData description |
| @serialField | Einen ObjectStreamField-Komponenten beschreiben. | @serialField name type description |
| @since | Markiert, wenn eine bestimmte Änderung eingeführt wird. | @since release |
| @throws | Wie der @exception-Tag. | Der @throws-Tag hat dasselbe Bedeutung wie der @exception-Tag. |
| {@value} | Die Werte eines Constants anzuzeigen, der ein staticAttribut sein muss. | Zeigt den Wert einer Konstanten an, die ein statisches Feld sein muss. |
| @version | gibt die Version der Klasse an | @version info |
In der /** danach, die ersten Zeilen oder einige Zeilen sind die Hauptbeschreibungen der Klasse, Variable und Methode.
danach können Sie eine oder mehrere verschiedene @ Schlüsselwörter. Jeder @ Schlüsselwörter müssen am Anfang einer neuen Zeile oder unmittelbar nach einem Sternen(*) am Anfang einer Zeile stehen:*).
Mehrfache gleiche Arten von Schlüsselwörtern sollten zusammengefasst werden. Zum Beispiel, wenn Sie drei @see Schlüsselwörter, die man nacheinander nebeneinander platzieren kann.
Nachstehend ist ein Beispiel für eine Klassenbeschreibungskommentar:
/*** Diese Klasse zeichnet ein Balkendiagramm. * @author w3codebox * @version 1.2 */
Das javadoc-Tool nimmt den Quellcode Ihres Java-Programms als Eingabe und gibt einige HTML-Dateien aus, die die Kommentare Ihres Programms enthalten.
Die Informationen jeder Klasse sind in einem separaten HTML-Dokument enthalten. javadoc kann auch das Vererbungshierarchiebaumuster und die Indexe ausgeben.
Da die Implementierung von javadoc unterschiedlich sein kann, kann die Arbeit auch unterschiedlich sein. Sie müssen die Version Ihres Java-Entwicklungssystems und andere Details überprüfen und die passende Javadoc-Version auswählen.
Nachstehend ist ein einfaches Beispiel für eine Anleitungskommentar. Beachten Sie, dass jeder Kommentar vor dem beschriebenen Projekt steht.
Nach der Verarbeitung durch javadoc finden Sie die Kommentare der SquareNum-Klasse in SquareNum.html.
import java.io;*;
/**
* Diese Klasse demonstriert Dokumentkommentare
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
/**
* Diese Methode gibt das Quadrat von num zurück.
* Dies ist eine mehrzeilige Beschreibung. Sie können
* so viele Zeilen wie Sie möchten.
* @param num Der zu quadrierende Wert.
* @return Das Quadrat von num.
*/
public double square(double num) {
return num * num;
}
/**
* Diese Methode liest eine Zahl vom Benutzer ein.
* @return Der Wert als 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);
}
}As follows, using the javadoc tool to process the SquareNum.java file:
$ 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 $