web-dev-qa-db-fra.com

Comment lisez-vous JavaDoc?

Quels outils/sites Web utilisez-vous pour lire JavaDocs?

J'utilise actuellement Firefox avec plus de 20 onglets ouverts lorsque je travaille sur un projet J2EE pour disposer de toute la documentation disponible, qui n'est pas très utilisable, qui consomme trop de mémoire et qui n'est pas interrogeable.

Ce que j'attendrais d'un tel outil/site web:

  • Agrégation de JavaDocs à partir de différents emplacements
  • Accès direct à des types tels que Ctrl + T dans Eclipse ou similaire
  • Recherche en texte intégral
  • Références croisées entre toutes les bibliothèques Java que j'ai choisies
  • Pour un outil: support hors ligne
  • La vitesse

pas obligatoire:

  • possibilité d'annoter des choses
  • support pour différentes versions d'une bibliothèque (+ diffing?)
  • Intégration IDE

Modifier:

Merci pour vos réponses. Je connaissais la plupart des sites mais leur ai donné un autre essai. Voici mon jugement:

  • fonctionnalités intégrées Eclipse/IDE
    • étroitement intégré
    • support hors ligne/en ligne
  •  javadoconline.com (n'est plus maintenu)
    • travaux
    • regards propres
    • trouve les correspondances dans plusieurs versions de l'API et permet de changer facilement
    • simple mais efficace
    • vite
  •  jdocs (hors ligne)
    • semble très sophistiqué
    • parfois lent
    • certaines versions récentes des bibliothèques semblent manquer (Seam 2.0.0, Hibernate Validators), mais il semble que vous puissiez les ajouter vous-même.
    • Intégration IDE (non testée)
    • commentaires de style wiki pour chaque élément
  • docjar.com
    • travaux
    • vite
    • interface utilisateur encombrée
  • javadoc_isearch
    • script greasemonkey pour firefox qui facilite la navigation dans javadocs
    • fonctionne parfaitement et parfaitement
javadocumentationjavadoc
29
jrudolph

Si vous utilisez Eclipse, il prend en charge les Javadocs. Par exemple, survolez un appel de méthode avec la souris pour afficher une info-bulle indiquant le Javadoc correspondant à cette méthode. La documentation relative aux classes Java principales est prise en charge immédiatement. Toutefois, si votre projet utilise des bibliothèques supplémentaires (fichiers JAR), une configuration est nécessaire pour pouvoir connecter leurs Javadocs à Eclipse.

  1. Accédez à la section "Chemin de construction Java" des propriétés de votre projet.
  2. Allez à l'onglet "Bibliothèques" et cliquez sur l'icône "plus" en regard du fichier JAR.
  3. Cliquez sur "Emplacement Javadoc", puis sur le bouton "Modifier ...".

Cela vous permettra de spécifier l'emplacement des Javadocs pour ce JAR. Il vous laissera même spécifier une URL de site Web, vous n'aurez donc pas à télécharger les Javadocs vous-même!

9
Michael

J'ai écrit mon propre outil pour cela. Selon mes collègues, le mieux est de les voir.

Il indexe une fois par lucene, et lance votre petit serveur en tâche de fond, donc parcourez les javadocs (pydocs, perldocs ..) comme dans le navigateur. Il permet également de séparer les bibliothèques par langue afin que les recherches comme "biginteger" ou simialr ne se trompent pas.

https://github.com/judovana/JavadocOfflineSearch/releases

2
judovana

Vous pouvez trouver JavaDoc/de l'université de Stanford ici .

2
Léo Léopold Hertz 준영

JavaDoc jar peut être décompressé directement. En théorie, tous les javadocs publiés peuvent être téléchargés et visualisés hors connexion. 

  1. télécharger directement depuis le dépôt maven. Par exemple: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

  2. Maintenant, vous obtenez objectify-5.0.3-javadoc.jar, renommez le fichier en objectify-5.0.3-javadoc.Zip

  3. utilisez votre outil de décompression préféré pour l'extraire, vous avez maintenant un dossier objectify-5.0.3-javadoc

  4. double-cliquez sur index.html pour ouvrir la page d'index de votre navigateur par défaut. 

2
Max

J'utilise http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ pour FF. Cela me permet également de parcourir facilement d’autres bibliothèques.

2
Swati

Ce plug-in pour Firefox et Chrome est utile pour trouver rapidement les noms de paquet et de classe, bien que ce ne soit pas une recherche en texte intégral: https://code.google.com/p/javadoc-search-frame/

1
Glenn Lawrence

Eclipse s'intègre parfaitement à Javadoc et dispose d'un visualiseur de type HTML. Vous pouvez associer la source et javadoc aux fichiers binaires qui apparaîtront lorsque vous sélectionnerez une classe.

1
Heath Borders

Quelque chose comme ça peut être utile?

http://www.docjar.com/

1
user7094

Personnellement, je n'ai jamais eu de problème avec les outils de navigation javadoc intégrés proposés par mon IDE.

Actuellement, j'utilise IntelliJ Idea - Ctl-Q affiche le javadoc pour la méthode sous le curseur, avec les hyperliens vers d'autres parties de la documentation fonctionnelle. 

J'imagine que NetBeans et Eclipse offrent des fonctionnalités similaires.

1
Rob Dickerson

Hm ... Que diriez-vous de:

  • http://edu.netbeans.org/quicktour/javadoc.html - NetBeans prend en charge le standard Javadoc pour la documentation Java - pour l'afficher et le générer.
  • http://globaldocs.zeevbelkin.com/ - Cette application permet de parcourir facilement, via Internet et le système de fichiers local, plusieurs jeux de javadoc à l'aide d'une arborescence hiérarchique de packages/classes et d'un index de recherche. Le visualiseur prend en charge les ensembles de documents locaux et distants (les ensembles de documents locaux, compressés dans des fichiers JAR/Zip sont également pris en charge).

Je préfère NetBeans car il obtient JavaDoc à partir de Maven ~/.m2 répertoire automatiquement ...

1
gavenkoa

Doxygen ( http://www.doxygen.nl/ ) pourrait convenir. 

EDIT: J'ai peut-être mal interprété votre question, doxygen est un outil permettant de générer de la documentation et des modèles basés sur votre code et votre javadoc. 

0
mmattax

Eclipse est un meilleur moyen de voir les javadocs. En survolant la souris avec une méthode ou une déclaration, vous obtiendrez des javadocs générés automatiquement par Eclipse.

0
Rohit deol