2009-07-03 16 views
122

est-il un bon exemple d'un 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 parcourir la source d'une bibliothèque quelque part, mais cela semble beaucoup de travail.bon exemple de Javadoc

Répondre

102

Que diriez-vous du code source JDK, mais accédé par un tiers comme docjar? Par exemple, le Collections source.

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

+1

C'est une bonne réponse depuis les collections où écrit par Josh et Neal – cherouvim

+0

Mon logiciel antivirus dit que le lien docjar est dangereux. Connaissez-vous d'autres sites Web qui présentent la source des collections? (Je laisserais glisser si ce n'était pas une question à fort trafic :) –

+2

Si sur Windows, l'installation JDK contient un fichier 'src.zip' avec la source code des bibliothèques standard –

8

Que diriez-vous du code source JDK?

+0

c'était ma pensée évidente mais je devais télécharger le grand désordre entier. :-( –

+4

Les chances sont que vous l'avez déjà, car il est livré avec le JDK (bien que ce soit une option d'installation) –

1

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

4

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

  • documentation toujours au sujet de la sécurité des threads
  • toujours la documentation immuabilité
  • javadoc avec des exemples (comme Formatter)
  • @Deprecation avec pourquoi et comment? pour remplacer l'élément annoté
1

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

3

Jetez un oeil à la source-cadre de printemps, il a d'excellentes javadocs

+9

C'est la chose la plus gentille que quelqu'un ait jamais dite au sujet du printemps. – Pedantic

2

Si vous utilisez Eclipse, vous pouvez configurer votre JDK (non JRE) dans JREs installés, puis utiliser Open type (Ctrl +Maj +T), donnent somethin g java.util.Collections

+1

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

1

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

Questions connexes