Une bonne référence pour populaire javadoc balises à utiliser?

Je voudrais utiliser les balises personnalisées dans ma documentation javadoc, mais s'en tenir à une sorte de convention, de sorte que d'autres personnes pourraient avoir un temps plus facile de donner un sens à eux. Sur Oracle officiel de la documentation javadoc de la page, ils ont énuméré la base de balises, ce qui est un petit ensemble, par rapport à la liste de balises qui apparaissent dans mon éditeur de la javadoc du code de l'affinage.

Est-il une bonne référence en ligne, qui répertorie populaire balises javadoc?

OriginalL'auteur Pup | 2011-05-24

  1. 9

    StackOverflow utilisateur Uri a fourni une liste de balises personnalisées qu'il propose, dans le cadre de ses études de Doctorat dans l'efficacité de la documentation javadoc comme un réponse à une question. Vous pourriez adopter ceux et ayez confiance en vous que vous utilisez quelque chose qui est soutenue par la recherche.

    Personnellement, j'avais juste coller avec le standard javadoc étiquettes et se conformer aux meilleures pratiques observées dans d'Oracle (Sun) Comment Écrire de la Doc Commentaires pour l'Outil Javadoc.

    Malheureusement, la question et la réponse des pages mentionnées au premier alinéa ont été supprimés. Cependant, l'Oracle de la page est toujours en place et semble être en cours; il a également des liens vers des pages connexes. Pour les informations détaillées, la page de Wikipedia sur la Javadoc est assez bonne et les listes de beaucoup de balises standard.

    OriginalL'auteur sho222

  3. 1

    Pas vraiment une réponse à la question, mais connexes:

    Pour utiliser des balises javadoc, vous devez utiliser un doclet (qui peut prendre en charge des balises qu'il veut), d'utiliser des taglets avec le doclet standard, ou utiliser le -tag paramètre de ligne de commande pour définir ces balises. Sinon vous obtiendrez un message d'avertissement de javadoc (et pas de sortie pour ce tag).

    Donc il ne fait vraiment sens pour utiliser des balises lorsque vous collaborent déjà avec quelqu'un qui les utilise, et ce quelqu'un va vous dire ce que javadoc options que vous avez à utiliser. (Ou vous ajoutez ces options vous-même).

    Je n'utilise pas non standard, les balises, les standards sont assez pour moi.

    OriginalL'auteur Paŭlo Ebermann

  4. 0

    J'ai découvert ce lien pour des exemples de balises javadoc

    OriginalL'auteur Hari Krishna