Ich würde gerne benutzerdefinierte Tags in meinen Javadocs verwenden, aber halte mich an eine Art Konvention, damit andere Leute es leichter haben, sie zu verstehen. Auf der offiziellen javadoc-Dokumentationsseite von Oracle haben sie die grundlegenden Tags aufgelistet, was eine kleine Menge ist, verglichen mit der Liste der Tags, die in den javadoc-Code-Hinweisen meines Editors erscheinen.
Gibt es online eine gute Referenz, die beliebte javadoc-Tags auflistet?
StackOverflow-Benutzer Uri hat eine Liste von benutzerdefinierten Tags zur Verfügung gestellt, die er im Rahmen seiner Doktorarbeit zur Effektivität von javadocs als Antwort zu einem verwandten Frage . Sie können diese übernehmen und haben ein gewisses Vertrauen, dass Sie etwas verwenden, das durch einige Forschung unterstützt wird.
Persönlich würde ich mich nur an die Standard-Javadoc-Tags halten und die Best Practices einhalten, die in Oracles (Suns) So schreiben Sie Doc-Kommentare für das Javadoc-Tool .
Nicht wirklich eine Antwort auf die Frage, aber verwandt:
Um benutzerdefinierte javadoc-Tags zu verwenden, müssen Sie entweder ein benutzerdefiniertes Doclet verwenden (das beliebige Tags unterstützen kann), benutzerdefinierte Taglets mit dem Standarddoclet verwenden oder den Befehlszeilenparameter -tag verwenden, um diese Tags zu definieren. Andernfalls erhalten Sie eine Warnung von javadoc (und keine Ausgabe für dieses Tag).
Es macht also nur Sinn, benutzerdefinierte Tags zu verwenden, wenn Sie bereits mit jemandem zusammenarbeiten, der sie verwendet, und dieser Jemand wird Ihnen sagen, welche Javadoc-Optionen Sie verwenden müssen. (Oder Sie fügen diese Optionen selbst hinzu).
Ich verwende keine nicht standardmäßigen Tags, die Standard-Tags sind genug für mich.
Tags und Links javadoc