docs - javadoc wiki

¿Cómo lees 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 esperaría de tal herramienta / sitio web:

• Agregue JavaDocs desde diferentes ubicaciones
• Acceso directo a tipos como Ctrl + T en Eclipse o similar
• Búsqueda de texto completo
• Referencia cruzada entre todas las bibliotecas de Java que he elegido
• Para una herramienta: soporte fuera de línea
• Velocidad

no es obligatorio:

• posibilidad de anotar cosas
• soporte para diferentes versiones de una biblioteca (¿+ diffing?)
• Integración IDE

Editar:

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

• funciones incorporadas de Eclipse / IDE
  • estrechamente integrado
  • soporte fuera de línea / en línea
• javadoconline.com (ya no se mantiene)
  • trabajos
  • miradas limpias
  • encuentra coincidencias en más de una versión de la API y permite una fácil conmutación
  • simple pero trabajando
  • rápido
• jdocs (fuera de línea)
  • parece muy sofisticado
  • a veces lento
  • parece que faltan algunas versiones recientes de las bibliotecas (Seam 2.0.0, Validadores de Hibernate) pero parece que puede agregarlas usted mismo
  • Integración IDE (no probada)
  • comentarios de estilo wiki para cada elemento
• docjar.com
  • trabajos
  • rápido
  • IU abarrotada
• javadoc_isearch
  • script de greasemonkey para firefox que facilita la navegación de javadocs
  • funciona sin problemas y perfectamente

Answer 1

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

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

2. Ahora obtienes objectify-5.0.3-javadoc.jar , renombra el archivo a objectify-5.0.3-javadoc.zip

3. usa tu herramienta de descompresión favorita para extraerla, ahora tienes una carpeta objectify-5.0.3-javadoc

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

Answer 2

Algo como esto puede ser útil?

http://www.docjar.com/

Answer 3

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

EDITAR: 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 4

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

Answer 5

Personalmente, nunca tuve un problema con las herramientas de navegación javadoc integradas que ofrece mi IDE.

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

Me imagino que NetBeans y Eclipse ofrecen una funcionalidad similar.

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

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

Answer 8

Puede encontrar el JavaDoc de la Universidad de Stanford aquí .

Answer 9

Hm ... ¿Qué tal?

• http://edu.netbeans.org/quicktour/javadoc.html - NetBeans es compatible con el estándar Javadoc para la documentación de Java, tanto para verlo como para generarlo.
• 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 obtiene ~/.m2 directorio Maven ~/.m2 automáticamente ...

Answer 10

Eclipse es la 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 11

Este complemento para Firefox y Chrome es útil para buscar rápidamente nombres de paquetes y clases, aunque no es una búsqueda de texto completo: https://code.google.com/p/javadoc-search-frame/

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 tu pequeño servidor en segundo plano, entonces yo busco 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