bon exemple de Javadoc

Existe-t-il un bon exemple de fichier source contenant Javadoc ?

Je peux trouver beaucoup de bons exemples de Javadoc sur Internet, je voudrais juste trouver la syntaxe particulière utilisée pour les créer, et supposer que je peux explorer la source de certaines bibliothèques quelque part, mais cela semble beaucoup de travail.

Qu’en est-il du code source JDK, mais accessible via un tiers comme docjar? Par exemple, la source Collections .

De cette façon, il n’y a pas de gros téléchargement.

La page Comment écrire les commentaires de Doc pour l’outil Javadoc contient un bon nombre de bons exemples. Une section est appelée Exemples de commentaires de document et contient plusieurs utilisations.

En outre, la FAQ Javadoc contient quelques exemples supplémentaires pour illustrer les réponses.

Qu’en est-il du code source JDK ?

J’utilise un petit ensemble de modèles de documentation:

  • documenter toujours sur la sécurité des threads
  • documentant toujours l’immuabilité
  • javadoc avec des exemples (comme Formatter )
  • @Déprécation avec WHY et COMMENT remplacer l’élément annoté

Jetez un coup d’oeil à la source du framework Spring, elle a d’excellents javadocs

Si vous utilisez Eclipse , vous pouvez configurer votre JDK (pas JRE ) dans les JRE installés , puis utiliser Open Type ( Ctrl + Shift + T ), donner quelque chose comme java.util.Collections

Télécharger les sources de Lucene et voir comment ils le font. Ils ont de bons JavaDocs.

Si vous installez un JDK et choisissez d’installer les sources également, le fichier src.zip contient la source de TOUTES les classes Java publiques. La plupart d’entre eux ont un bon javadoc.

La documentation du package et des classes EventBus de Google Guava est un bon exemple de Javadoc. En particulier, la documentation du paquet avec le démarrage rapide est bien écrite.

Si tout ce que vous recherchez est la syntaxe, cela peut vous aider:

Comment écrire des commentaires de document pour l’outil Javadoc