MatthiasHertel
commented
7 years ago ja mit javadoc tags ... so das wir nen javadoc html gerendert haben...
bekannte tags: https://de.wikipedia.org/wiki/Javadoc
| Tag und Parameter | Ausgabe | Verwendung in | seit |
|---|---|---|---|
@author name |
Beschreibt den Autor. | Klasse, Interface | |
@version version |
Erzeugt einen Versionseintrag. Maximal einmal pro Klasse oder Interface. | Klasse, Interface | |
@since jdk-version |
Seit wann die Funktionalität existiert. | Klasse, Interface, Instanzvariable, Methode | |
@see reference |
Erzeugt einen Link auf ein anderes Element der Dokumentation. | Klasse, Interface, Instanzvariable, Methode | |
@serial |
Bei einem Serializable Object beschreibt es die serialisierten Daten des Objekts. |
Klasse | |
@serialField |
Dokumentiert ein Feld von einem Serializable Objekt. | Klasse, Methode | |
@param name description |
Parameterbeschreibung einer Methode. | Methode | |
@return description |
Beschreibung des Rückgabewerts einer Methode. | Methode | |
@exception classname description@throws classname description |
Beschreibung einer Exception, die von dieser Methode geworfen werden kann. | Methode | |
@deprecated description |
Beschreibt eine veraltete Methode, die nicht mehr verwendet werden sollte. Sollte ab Java 5.0 immer mit der @Deprecated-Annotation verwendet werden. |
Methode | |
{@inheritDoc} |
Kopiert die Beschreibung aus der überschriebenen Methode. | Überschreibende Methode | 1.4.0 |
{@link reference} |
Link zu einem anderen Symbol. | Klasse, Interface, Instanzvariable, Methode | |
{@linkPlain reference} |
Der Link wird in Standardtext statt in Quelltextzeichensatz angezeigt. | Klasse, Interface, Instanzvariable, Methode | 1.4.0 |
{@value} |
Gibt den Wert eines konstanten Feldes zurück. | Statisches Feld | 1.4.0 |
{@docRoot} |
Gibt den absoluten Pfad zum Hauptverzeichnis wieder. | Package, Klassen, Felder, Methoden | |
{@code} |
Formatiert Text buchstabengetreu mit dem Quelltextzeichensatz (entsprechend <code>) und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags. | Klasse, Interface, Instanzvariable, Methode | 5.0 |
{@literal} |
Kennzeichnet buchstabengetreuen Text und unterdrückt die Interpretierung von beinhalteten HTML oder Javadoc-Tags. | Klasse, Interface, Instanzvariable, Methode | 5.0 |
markweigelt
momentan gibts fast keine Kommentare --muss noch gemacht werden