bon exemple de Javadoc [fermé]

140

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 connaître la syntaxe particulière utilisée pour les créer, et je suppose que je peux parcourir la source d'une bibliothèque quelque part, mais cela semble être beaucoup de travail.

java javadoc Jason S
la source

Réponses:

118

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.

GaryF
la source
1
C'est une bonne réponse puisque les collections ont été écrites par Josh et Neal.
cherouvim
Mon logiciel antivirus dit que le lien docjar n'est pas sûr. Connaissez-vous d'autres sites Web présentant la source des collections? (Je le laisserais glisser si ce n'était pas une question assez fréquentée :)
Gordon Gustafson
2
Si sous Windows, l'installation JDK contient un src.zipfichier avec le code source des bibliothèques standard.
Sri Harsha Chilakapati
Comment est-il légal pour un tiers de distribuer un code protégé par des droits d'auteur? Ou le droit d'auteur le permet-il?
ThePyroEagle
C'est le principal problème avec les liens externes, "Docjar.net est DOWN pour tout le monde."
Livre de Zeus
9

Qu'en est-il du code source JDK ?

poulet au beurre
la source
c'était ma pensée évidente mais je devrais télécharger tout le gros désordre. :-(
Jason S
5
Il y a de fortes chances que vous l'ayez déjà, car il est livré avec le JDK (bien que ce soit une option d'installation).
Michael Borgwardt
5

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

  • toujours documenter la sécurité des threads
  • toujours documenter l'immuabilité
  • javadoc avec des exemples (comme Formatter )
  • @Deprecation avec POURQUOI et COMMENT remplacer l'élément annoté
dfa
la source
bon indice pour inclure COMMENT remplacer le obsolète, thx
Tobi Tiggers
4

Jetez un œil à la source du framework Spring, il contient d'excellents javadocs

Gaël Marziou
la source
2

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

RichieHindle
la source
2

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 commejava.util.Collections

KrishPrabakar
la source
1
Pour ajouter à ce qui a été dit, la plupart des IDE configurent automatiquement les javadocs et la source lorsque vous configurez le JDK pour qu'ils les utilisent. Cela ne s'applique pas uniquement à Eclipse.
ThePyroEagle
2

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

Marvin Frommhold
la source
1

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

Thorbjørn Ravn Andersen
la source