WikiDer > Javadoc
Javadoc
Java-Plattformportal Javadoc ist ein Dokumentationsgenerator von dem Java-Entwicklungskit (JDK), wodurch HTML-Seiten mit APIDokumentation erstellt werden. Die API-Dokumentation wird verwendet, um ein Programm zu beschreiben, sie gibt an, in welchem Pakete und Klassen ein Java Programm ist klassifiziert, was Variablen und Methoden es gibt, und was genau sie im Programm tun.
Javadoc ist der Industriestandard für die Dokumentation von Java-Programmen, und die meisten Integrierte Entwicklungsumgebung (IDE) generiert automatisch Javadoc-Dokumentation.
Programmierer können bestimmte Kommentare und Javadoc-Elemente verwenden, um Teile detaillierter zu beschreiben und zusätzliche Referenzen von Javadoc generieren zu lassen:
| Element | Beschreibung |
|---|---|
| @Autor | Name des Programmierer |
| @veraltet | Markiert die Methode als veraltet. |
| @Ausnahme | Gibt an, wann eine Ausnahme von einer Methode ausgelöst werden kann — siehe auch @throws. |
| @param | Definiert einen Parameter einer Methode. Obligatorisch für jeden Parameter. |
| @Rückkehr | Dokumentiert den zurückgegebenen Wert. Sollte nicht für Methoden verwendet werden, die Leere Rückkehr. |
| @kehrt zurück | Ein Synonym für @return. |
| @sehen | Weist auf einen Verweis auf eine andere Methode hin oder Klasse. |
| @schon seit | Gibt an, wenn der Klasse eine Methode hinzugefügt wurde. |
| @würfe | Dokumentiert die ausgelöste Ausnahme. Ein Synonym für @Exception, eingeführt in Javadoc 1.2. |
| @Ausführung | Gibt die Versionsnummer einer Methode oder Klasse an. |
Ein Anwendungsbeispiel:
/*** Zeigt den Namen der Person an* @Autor John Doe* @param id Personenidentifikationsnummer* @return Name der gefundenen Person* @seit 01.01.2000* @version 1.0* @Exception PersonNotFoundException Wenn keine Person mit der angegebenen Kennung gefunden werden kann*/ZeichenfolgegetName(intIch würde)wirftPersonNotFoundException{...}