CloudMarketing

Wie bereits im September geschrieben, ist eine gute Entwickler-Dokumentation essentiell für die Software-Wartung und verteilte Nutzung von Quellcode. An dieser Stelle sei die Tag-Liste für JavaDoc, die Dokumentationsanweisungen für Java, vorgestellt.

Befehle

@author Vorname Nachname
Beschreibt den Autor (Vorname und Nachname). Grundsätzliche Verwendung in Klassen und Interface. Sicherlich lässt sich dieser Teil auch bei Methoden benutzen, dennoch sollte man sich als Entwickler die Grundzüge des Styleguides einer Programmiersprache zu Herzen nehmen.

@return variable
Beschreibt einen oder mehrere Rückgabewerte, bzw. die Rückgabewerte einer Methode. Wie unschwer zu erkennen, gilt dieser Tag grundsätzlich bei Methoden, zumindest bei solchen, die einen Rückgabewert besitzen.

@param parameter beschreibung
Beschreibt den oder die angegebenen Parameter einer Methode.

@version 0.0.1.1
Wie man bereits aus dem Tag herauslesen kann, geht es hier um die Versionsnummer. Diese kann abhängig vom Projektverlauf selbst frei bestimmt werden und ist immer in einer Klasse oder einem Interface eingebunden.

@since jdk-version 1.2
“Since” (zu Deutsch: seit wann) sagt aus, wie lang bereits dieser Teil, d. h. die Klasse, die Methode, diese Variable vorhanden ist.

{@inheritDoc}
Kopiert bzw. übernimmt die Beschreibung der überschriebenen Methode.

@exception classname Beschreibung
@throws classname Beschreibung
Beide Tags dienen der Beschreibung einer Exception, die von einer Methode geworfen werden kann. Dementsprechend gelten diese Tags auch nur für eine Methode.

@see reference
Durch diesen Tag, wird eine Referenz auf die Dokumentation anderen anderen Java-Klasse, Methode oder Variable erzeugt.

{@link reference}
Erstellt ein Link zu einem anderen Symbol – geeignet für eine Klasse, Methode, Instanzvariabel oder ein Interface.

@deprecated Beschreibung
Dieser Tag beschreibt eine Methode, welche veraltet oder nicht mehr vorhanden ist, aber ggf. aus Kompatibilitätsgründen nicht entfernt werden darf.

• 
• 
• 
• 
• 
• 
•