¿Cómo se lee JavaDoc?

Question

¿Qué herramientas/sitios web usas para leer JavaDocs?

Actualmente uso Firefox con más de 20 pestañas abiertas cuando trabajo en un proyecto J2EE para tener toda la documentación disponible que no es muy útil, está consumiendo demasiada memoria y no se puede buscar.

Lo que se puede esperar de una herramienta/sitio web tales:

• JavaDocs agregadas de diferentes lugares
• Acceso directo a tipos como Ctrl + T en Eclipse o similares
• de búsqueda de texto completo
• Cruz haciendo referencia entre todas las bibliotecas Java que he elegido
• Para una herramienta: soporte fuera de línea
• Velocidad

no es obligatorio: (? + Diffing)

• posibilidad de anotar cosas
• soporte para diferentes versiones de una biblioteca
• integración IDE

Editar:

Gracias por sus respuestas. Conocía la mayoría de los sitios pero les di otra oportunidad. Aquí está mi juicio:

• características built-in de Eclipse/IDE
  • estrechamente integrado
  • offline/soporte en línea
• javadoconline.com (ya no se mantiene)
  • obras
  • miradas limpias
  • encuentra coincidencias en más de una versión de la API y permite la conmutación
  • sencilla pero trabajando fácil
  • rápida
• jdocs (sin conexión)
  • parece muy sofisticado
  • veces lento
  • Parece que faltan algunas versiones recientes de las bibliotecas (Seam 2.0.0, Hibernate validadores) pero parece que se les puede agregarse
  • integración IDE (no probado)
  • comentarios de estilo wiki para cada elemento
• docjar.com
  • funciona
  • rápida
  • IU desordenada
• javadoc_isearch
  • script de Greasemonkey para Firefox, que hace que la navegación más fácil
  javadocs
  • funciona suave y perfectamente

Answer 1

Eclipse integra bien con Javadoc y tiene un visor de tipo HTML para ello. Puede adjuntar fuente y javadoc a los binarios que se mostrarán cuando seleccione una clase.

Answer 2

Doxygen (http://www.stack.nl/~dimitri/doxygen/) podría encajar en la cuenta.

EDIT: puede que haya leído mal tu pregunta, doxygen es una herramienta para generar documentación y modelos basados ​​en tu código y javadoc.

Answer 3

¿Algo como esto puede ser útil?

http://www.docjar.com/

Answer 4

Personalmente, nunca he tenido un problema con las herramientas de navegación incorporados en javadoc ofrecidos por mi IDE.

Actualmente, utilizo IntelliJ Idea - Ctl-Q muestra el javadoc para el método debajo del cursor, con los hipervínculos a otras partes de la documentación funcional.

Me imagino que NetBeans y Eclipse ofrecen una funcionalidad similar.

Answer 5

Yo uso http://www.teria.com/~koseki/tools/gm/javadoc_isearch/ para FF. Me permite navegar fácilmente otras bibliotecas también.

Answer 6

Si usa Eclipse, ofrece soporte para Javadocs. Por ejemplo, al pasar el mouse sobre una llamada a método se mostrará una información sobre herramientas que le muestra el Javadoc para ese método. La documentación para las clases principales de Java se admite de forma inmediata. Sin embargo, si su proyecto utiliza bibliotecas adicionales (archivos JAR), se requiere alguna configuración para conectar sus Javadocs a Eclipse.

1. Vaya a la sección "Ruta de compilación de Java" de las propiedades de su proyecto.
2. Vaya a la pestaña "Bibliotecas" y haga clic en el ícono "más" al lado del archivo JAR.
3. Haga clic en "Ubicación de Javadoc", luego en el botón "Editar ...".

Esto le permitirá especificar dónde se encuentran los Javadocs para ese JAR. ¡Incluso le permitirá especificar la URL de un sitio web, por lo que no tiene que descargar los Javadocs usted mismo!

Answer 7

Puede encontrar JavaDoc here de la Universidad de Stanford.

Answer 8

Hm ... ¿Qué tal:

• http://edu.netbeans.org/quicktour/javadoc.html - NetBeans soporta el estándar para la documentación Javadoc de Java - tanto la visualización y la generación de la misma.
• http://globaldocs.zeevbelkin.com/ - Esta aplicación permite navegar convenientemente, a través de Internet y el sistema de archivos local, múltiples conjuntos de javadoc, utilizando un único árbol de jerarquía de paquetes/clases y un índice de búsqueda. El visor admite docsets locales y remotos (los docsets locales, empaquetados en archivos JAR/ZIP también son compatibles).

prefiero NetBeans ya que llegar JavaDoc de Maven~/.m2 directorio de forma automática ...

Answer 9

Eclipse es una mejor manera de ver los javadocs. Al pasar el ratón sobre el método o cualquier declaración, se obtendrán javadocs generados automáticamente por eclipse.

Answer 10

este plug in para Firefox y Chrome es útil para encontrar rápidamente los nombres de paquetes y de clase, aunque no es una búsqueda de texto completo: https://code.google.com/p/javadoc-search-frame/

Answer 11

frasco JavaDoc puede ser descomprimido directamente. En teoría, todos los javadocs lanzados se pueden descargar y visualizar sin conexión.

1. descargue directamente del repositorio de maven. Por ejemplo: http://central.maven.org/maven2/com/googlecode/objectify/objectify/5.0.3/objectify-5.0.3-javadoc.jar

2. Ahora usted consigue objectify-5.0.3-javadoc.jar, cambiar el nombre del archivo a objectify-5.0.3-javadoc.zip

3. utilizar su herramienta de descompresión favorita para extraerlo, ya que tiene una carpeta objectify-5.0.3-javadoc

4. doble clic index.html abrirá la página de índice en su navegador predeterminado.

Answer 12

Escribí mi propia herramienta para esto. Según mis colegas, es mejor que lo hayan visto.

Indexa por lucene una vez, y ejecuta su pequeño servidor en segundo plano, por lo que hojea javadocs (pydocs, perldocs ..) como en el navegador. También permite bibliotecas separadas por idioma, por lo que las búsquedas como "biginteger" o simialr no salen mal.

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