bon exemple de Javadoc
existe-t-il un bon exemple de fichier source contenant Javadoc ?
Je peux trouver beaucoup d’excellents exemples de Javadoc sur Internet. Je voudrais juste découvrir la syntaxe particulière utilisée pour les créer, et supposer que je peux explorer la source d’une bibliothèque quelque part, mais cela semble être beaucoup de travail.
Que diriez-vous du code source JDK, mais accessible via un tiers tel que docjar? Par exemple, Source des collections .
De cette façon, il n'y a pas de gros téléchargement.
La page Comment rédiger des commentaires de document pour l'outil Javadoc contient un bon nombre de bons exemples. Une section s'appelle Exemples de commentaires Doc et contient pas mal d'usages.
En outre, le Javadoc FAQ 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:
- toujours documenter sur la sécurité du fil
- toujours documenter l'immuabilité
- javadoc avec des exemples (comme Formatter )
- @Deprecation with WHY et HOW pour remplacer l'élément annoté
Jetez un oeil à la source du framework Spring, elle contient d'excellents javadocs
ANT par exemple - code source consultable en ligne: http://svn.Apache.org/viewvc/ant/core/trunk/src/main/org/Apache/tools/ant/DefaultLogger.java?view=co
Pour choisir d'autres fichiers, commencez par: http://svn.Apache.org/viewvc/ant/core/trunk/src/main/org/Apache/tools/ant/?pathrev=761528
La documentation du package et des classes EventBus de Google Guava est un bon exemple de Javadoc. En particulier, la documentation du paquetage avec le démarrage rapide est bien écrite.
Téléchargez les sources de Lucene et voyez comment ils le font. Ils ont de bons JavaDocs.
Si vous utilisez Eclipse, vous pouvez configurer votre JDK (not JRE) dans JRE installés, puis utilisez Type ouvert (Ctrl + Shift + T), donne quelque chose comme Java.util.Collections
Si vous installez un JDK et que vous choisissez d'installer également des sources, src.Zip contient la source de TOUTES les classes publiques Java. La plupart d'entre eux ont un très bon javadoc.
Si tout ce que vous cherchez est la syntaxe, alors cela peut aider:
Comment écrire des commentaires de document pour l'outil Javadoc