it-swarm-es.tech

¿Cómo se lee JavaDoc?

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

Actualmente utilizo 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 utilizable, consume demasiada memoria y no se puede buscar.

Lo que esperaría de dicha 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 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:

  • características incorporadas de Eclipse/IDE
    • estrechamente integrado
    • soporte fuera de línea/en línea
  • javadoconline.com (ya no se mantiene)
    • trabajos
    • apariencia limpia
    • encuentra coincidencias en más de una versión de la API y permite cambiar fácilmente
    • simple pero trabajando
    • rápido
  • jdocs (sin conexión)
    • parece muy sofisticado
    • a veces lento
    • parece que faltan algunas versiones recientes de las bibliotecas (Seam 2.0.0, Hibernate Validators) pero parece que puede agregarlas usted mismo
    • Integración IDE (no probado)
    • comentarios de estilo wiki para cada elemento
  • docjar.com
    • trabajos
    • rápido
    • iU desordenada
  • javadoc_isearch
    • script de greasemonkey para firefox que facilita la navegación por javadocs
    • funciona suave y perfectamente
30
jrudolph

Si usa Eclipse, ofrece soporte para Javadocs. Por ejemplo, al pasar el mouse sobre una llamada a un método, aparecerá una información sobre herramientas que le mostrará el Javadoc para ese método. Documentación para el núcleo Java clases son compatibles fuera de la caja. Sin embargo, si su proyecto utiliza bibliotecas adicionales (archivos JAR), se requiere alguna configuración para conectar sus Javadocs en Eclipse.

  1. Vaya a la sección "Java Build Path" de las propiedades de su proyecto.
  2. Vaya a la pestaña "Bibliotecas" y haga clic en el icono "más" junto al 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!

9
Michael

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

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

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

2
judovana

Puede encontrar JavaDoc de la Universidad de Stanford aquí .

JavaDoc jar se puede descomprimir directamente. En teoría, cualquier javadocs lanzado se puede descargar y ver sin conexión.

  1. descargue directamente desde el 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 obtienes objectify-5.0.3-javadoc.jar, cambie el nombre del 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 index.html abrirá la página de índice en su navegador predeterminado.

2
Max

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

2
Swati

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

1
Glenn Lawrence

Eclipse se integra bien con Javadoc y tiene un visor similar a HTML. Puede adjuntar código fuente y javadoc a los archivos binarios que aparecerán cuando seleccione una clase.

1
Heath Borders

¿Algo como esto puede ser útil?

http://www.docjar.com/

1
user7094

Personalmente, nunca he tenido 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 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.

1
Rob Dickerson

Hm ... ¿Qué tal:

  • http://edu.netbeans.org/quicktour/javadoc.html - NetBeans admite el estándar Javadoc para la documentación Java - tanto para verlo como para generarlo.
  • http://globaldocs.zeevbelkin.com/ - Esta aplicación permite navegar cómodamente, a través de Internet y el sistema de archivos local, múltiples conjuntos javadoc, usando un único árbol de jerarquía de paquetes/clases y un índice de búsqueda. El visor admite conjuntos de documentos locales y remotos (también se admiten los conjuntos de documentos locales, empaquetados en archivos JAR/Zip).

Prefiero NetBeans ya que obtiene JavaDoc de Maven ~/.m2 directorio automáticamente ...

1
gavenkoa

Doxygen ( http://www.doxygen.nl/ ) podría ajustarse a la factura.

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

0
mmattax

Eclipse es la mejor manera de ver los javadocs. Al pasar el mouse sobre el método o cualquier declaración, Eclipse generará javadocs automáticamente.

0
Rohit deol