Eine Liste der Javadoc-Tags
Javadoc oder "The Java API Documentation Generator," generiert HTML-Seiten, die API-Dokumentation aus Java-Quellcode-Dateien enthält. Grundlegendes zu Javadoc-Tags kann, Programmieren mit Javadoc einen optimierten Prozess, wie Ihr Wissen über diese Tags Sie Code schreiben, schnell und effizient können. Eine Anzahl von unterschiedlichen Javadoc-Tags vorhanden sind, jeweils speziell für einen bestimmten Aspekt des Codes, der für die automatische Generierung einer API aus dem Quellcode ermöglicht.
Navigieren Sie zur Liste der Javadoc-Tags
Öffnen Sie einen Web-Browser Ihrer Wahl, und navigieren Sie zu der Liste der Javadoc-Tags auf der Oracle-Website. Am oberen Rand der Seite finden Sie den Link zu Javadoc-Tags unter "Reference Guide." Auswahl dieser Link bringt Sie zur eine Liste der Javadoc-Tags, die für die Verwendung verfügbar sind.
Hinweise zur wichtigen Syntax
Die Syntax der Javadoc-Tags zu verstehen ist wichtig, um richtig zu implementieren. Javadoc-Tags beginnen mit der "bei" melden und auch Groß-/Kleinschreibung. Es ist wichtig, dass Sie diese Syntaxregeln befolgen, wenn Sie mit Javadoc-Tags arbeiten. Ein Beispiel eines Javadoc-Tags für den Autor würde wie folgt aussehen:
@author
Anmerkung, die mit das Tag beginnt die "bei"-Zeichen und ist nur aus Kleinbuchstaben, wie der Fall auf der bereitgestellten Liste von Javadoc-Tags.
Wichtigsten Javadoc-Tags
Es kennzeichnet eine Anzahl von Javadoc, welche in einer Vielzahl von Anwendungen genutzt werden können. Im folgenden sind einige wichtige Javadoc-Tags und deren Funktionen:
@author - dieser Tag wird verwendet, um einen Autor-Eintrag hinzuzufügen. Sie können mehrere @author Tags pro Dokument sowie mehrere Namen pro Tag haben.
@see - dieser Tag wird verwendet, um eine Verknüpfung zu erstellen, die durch eine URL #value definiert ist. Mit diesem Tag Beispielsyntax lautet wie folgt:
@see < a href="test.html > Test </a >
Dies erzeugt einen Link auf der Testseite angezeigt als "Test."
@version - dieser Tag wird verwendet, um die aktuelle Versionsnummer der Software anzuzeigen, die programmiert wird ist.
Unterschied zwischen Block- und Inline-Tags
Ein wichtiger Punkt bezüglich Javadoc-Tags ist ihre Platzierung innerhalb des Codes. Block-Tags können nur im Abschnitt Tag platziert werden, die die wichtigste Beschreibung folgt. Inline-Tags, auf der anderen Seite können überall platziert werden, in der wichtigsten Beschreibung und/oder in den Kommentaren für Block-Tags, und sind in der Liste der Markierungen durch geschweifte Klammern ({@tag}) gekennzeichnet. Es ist wichtig, Javadoc-Tags an den richtigen Stellen zu verwenden.