bon exemple de Javadoc [fermé]
Est-il un bon exemple de fichier source contenant Javadoc?
Je peux trouver beaucoup de bons 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 parcourir la source d'une bibliothèque quelque part, mais cela semble beaucoup de travail.
11 answers
Que diriez-vous 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 des commentaires de Doc 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.
De plus, la FAQ Javadoc contient d'autres exemples pour illustrer les réponses.
Que diriez-vous du JDK code source?
J'utilise un petit ensemble de documents modèles:
- toujours documenter sur la sécurité des threads
- toujours documenter l'immutabilité
- javadoc avec des exemples (comme Formateur)
- @ Deprecation avec POURQUOI et COMMENT remplacer l'élément annoté
Jetez un oeil à Spring framework source, il a 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
Si vous utilisez Eclipse, vous pouvez configurer votre JDK (pas JRE) dans Installé Jre, puis utilisez de Type Ouvert (Ctrl + Maj + T), donner quelque chose comme java.util.Collections
Téléchargez les sources deLucene et voyez comment ils le font. Ils ont de bons JavaDocs.
Si vous installez un JDK et choisissez d'installer des sources aussi, le src.zip contient la source de TOUTES les classes Java publiques. La plupart d'entre eux ont assez bon javadoc.
La documentation du package et des classes de Google GuavaEventBus est un bon exemple de Javadoc. En particulier, la documentation du package avec le démarrage rapide est bien écrite.
Si tout ce que vous recherchez est la syntaxe, cela peut aider: