2010-03-27 24 views
35

Sé que puede presionar shift + alt + j para insertar una plantilla de comentario apropiada para el bloque de código actual, pero ¿hay alguna manera de dejar que eclipse se vuelva loco y hacer un proyecto completo como este?¿Alguna forma de generar automáticamente TODOS los comentarios de Javadoc en Eclipse?

+0

Erm, ¿alguna razón válida para hacerlo? Conozco personas que piensan que los documentos generados automáticamente son mejores que ninguno, pero en realidad no contienen más información ... simplemente hace que sea mucho más difícil encontrar los lugares que necesitan documentación ... – Joey

+11

Sí, hay una razón válida para hacer esto. Me ahorrará tener que presionar manualmente shift + alt + j cientos de veces mientras reviso todo mi código escribiendo javadoc. – Finbarr

+0

Espero que quiera saber que nunca lo usará accidentalmente,) – eckes

Respuesta

53

Durante todo un proyecto , puede ser que no, pero al menos puede:

  • ir al Explorador de paquetes Ver
  • ampliar la clase que desea generar comentarios en (abrir cada método)
  • seleccionar todos los elementos abiertos en la clase de que el explorador de paquetes árbol
  • alt +cambio + J y voilà: comentarios generados en la clase, y todos los métodos

La única razón por la que no es práctico para todo proyecto es:

  • es necesario abrir todas las clases que desea generar comentarios en
  • una vez que se ha comentado un primer conjunto de métodos, aún necesita repetir el proceso si ha escrito nuevos métodos.

Dicho esto, otro enfoque se describe en el artículo "The Problem of Incomplete Javadocs" de marzo, 30 de 2010, abogando por un extended Javadoc view.

La vista ampliada de Javadoc es esencialmente un agregador de diferentes fuentes de información para un solo elemento de código como una clase, método, campo o parámetro. Está diseñado como un reemplazo del Eclipse Javadoc existente.

alt text

La parte interesante viene con las otras fichas de la vista: Directivas de subclases y patrones de subclases.
Estas pestañas contienen información minada acerca de cómo los desarrolladores suelen extender el elemento de código seleccionado. pestaña

  • subclases:

directivas de subclases son generalizaciones de observaciones realizadas con frecuencia en ejemplo de código como "Las subclases de Asistente siempre anulan su método addPages()" o "Reimplementors de Dialog.createContents() puede llamar a su súper implementación".

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

  • Patrones de subclases Tab

patrones de subclases tratan de grupo observaron extensiones de una clase base en patrones de extensión típicos, es decir, que se agrupan subclases por similitud para encontrar patrones en los datos.

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

+0

¿Podría indicar el ítem del menú para el atajo Alt + Shift + J para nosotros, las personas de Mac? –

+0

@Nithesh: Cmd-Shift-J en una Mac como se menciona en http://mobile.tutsplus.com/tutorials/android/javadoc/ – VonC

+0

Nota para mí: las insignias de "buena respuesta" e "Ilustración" vienen con esa décima el voto marcó mi placa número 1000 en SO, el 24 de agosto de 2012. – VonC

6

También hay este plugin, que todavía tengo que probar, pero parece prometedor: JAutoDoc

19

Yo también estaba buscando una herramienta javadoc automático para Eclipse y encontré uno llamado JAutodoc.

Esta herramienta genera comentarios bastante bien y solo requiere cambios menores manualmente en algunos lugares (si es necesario). En mi opinión, esta herramienta puede ahorrar aproximadamente el 75% del tiempo dedicado a escribir comentarios.

Puede visitar here para obtener instrucciones detalladas sobre cómo descargarlo e integrarlo con Eclipse.

+1

Gracias @Arun. Tengo comentarios configurados en Eclipse, pero Alt + Shift + J pone un javadoc vacío en lugar de usar uno configurado (Preferencias> Java> Estilo de código> Plantillas de código). JAutodoc hizo justo lo que yo quería. Ahora tengo JAutodoc en la lista requerida :) –

+0

JAuto Doc genera mejores comentarios que el eclipse Alt + Shift + J – Sabyasachi

Cuestiones relacionadas