J'aimerais utiliser des étiquettes personnalisées dans mes javadocs, mais coller à une sorte de convention afin que d'autres personnes puissent avoir une idée plus facile de leur donner un sens. Sur la page de documentation officielle Javadoc d'Oracle, ils ont énuméré les balises de base, qui est un petit ensemble, comparé à la liste des balises qui apparaissent dans l'allusion de code Javadoc de mon éditeur.
Y a-t-il une bonne référence en ligne, qui répertorie les balises Javadoc populaires?
5 Réponses :
Pas vraiment une réponse à la question, mais connexe:
Pour utiliser des balises Javadoc personnalisées, vous devez soit utiliser un doculet personnalisé (qui peut prendre en charge les étiquettes qu'il souhaite), utilisez des étiquettes personnalisées avec le doculet standard ou utilisez le paramètre de ligne Il est donc logique que d'utiliser des balises personnalisées lorsque vous collaborez déjà avec quelqu'un qui les utilise, et que quelqu'un vous dira des options Javadoc que vous devez utiliser. (Ou vous ajoutez ces options vous-même).
Je n'utilise aucune étiquette non standard, les standards suffisent pour moi. -tag . définir ces tags. Sinon, vous obtenez un avertissement de Javadoc (et aucune sortie pour cette balise).
Stackoverflow utilisateur URI a fourni une liste de balises personnalisées qu'il propose dans le cadre de sa recherche sur le doctorat sur l'efficacité de Javadocs comme un Répondre à un . Vous pouvez adopter ceux-ci et avoir une certaine confiance que vous utilisez quelque chose qui est soutenu par certaines recherches.
Personnellement, je voudrais juste rester avec les étiquettes javadoc standard et adhérer aux meilleures pratiques constatées dans Oracle (Sun's) Comment écrire des commentaires de DOC pour l'outil Javadoc .
Malheureusement, les pages de questions et réponses mentionnées dans le premier paragraphe ont été supprimées. Cependant, la page Oracle est toujours en place et semble être à jour; Il est également destiné à certaines pages connexes. Pour des informations moins détaillées, la page Wikipedia sur Javadoc est plutôt bonne et répertorie beaucoup de balises standard.
Javadoc (Java JDk 8) :
http://docs.oracle.com/javase /8/docs/technotes/tools/windows/javadoc.html#chdjgijb
Javadoc (Java JDk 7) : http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags