2009-11-21 20 views
177

Duplicar posible:
Javadoc template generator¿Cómo puedo generar comentarios de Javadoc en Eclipse?

¿Hay una manera de generar comentarios Javadoc en Eclipse? Si es así, ¿qué es?

+0

Cerrando como una víctima porque OP indicó encontrar la respuesta en SO: http://stackoverflow.com/questions/1777175/how-can-i-generate-javadoc-comments-in-eclipse/1777177#comment-1662853 – Kev

+0

Probé la respuesta alternativa (hace 2 años) y no me gustó, así que considérelo dup o no. –

+0

Duplicado o no, este es el resultado superior al buscar en Google "eclipse generate javadoc" – Holloway

Respuesta

317

Para mí la /**<NEWLINE> o Shift - Alt - J (o - Alt - J en una Mac) el enfoque funciona mejor.

No me gusta ver los comentarios de Javadoc en el código fuente que se han generado automáticamente y no se han actualizado con contenido real. En lo que a mí respecta, tales javadocs no son más que un desperdicio de espacio en la pantalla.

IMO, es mucho mejor generar los esqueletos de comentarios de Javadoc uno por uno ya que está a punto de completar los detalles.

+14

Para ahorrar espacio, ¡pliégalo! –

+27

@Pascal - Preferiría eliminarlos o no generarlos en primer lugar. IMO, los comentarios javadoc generados añaden valor cero ... a menos que se cuente un aumento falso de la relación comentario-código como "valor". –

+0

Esto es lo que termino haciendo. –

34

JAutoDoc:

un plugin Eclipse para añadir automáticamente los encabezados y archivos Javadoc a su código fuente. Genera opcionalmente comentarios iniciales de nombre del elemento mediante el uso de Velocitytemplates para los encabezados y archivos Javadoc ...

+1

mejor que el construido en alt-shift-j – trusktr

13

En un lugar donde desea javadoc, el tipo de /** < NEWLINE> y se creará la plantilla.

+0

1. que funciona, gracias. 2. ese elemento de menú no está en ninguna de las perspectivas que uso. –

+0

me interesa saber cuál es su perspectiva – medopal

+1

Generar Javadoc no genera comentarios de Javadoc. Analiza los comentarios de Javadoc y genera documentación del proyecto (generalmente HTML) – ebelisle

25

¿Quieres decir menú Proyecto -> Generar Javadoc?

+0

Ese elemento del menú no está en ninguna de las perspectivas que uso. –

+0

Está en mi Eclipse, y las únicas cosas adicionales que he instalado son Google Web Toolkit y FindBugs. (Esto es Ganimedes, no Europa. ¿Quizás necesites actualizar?) –

+0

Solo tengo la perspectiva gwt, eclipse v 3.5.1 –

72

Shift-Alt-J es un atajo de teclado útil en Eclipse para crear plantillas de comentarios de Javadoc.

Invocando el acceso directo en una declaración de clase, método o campo creará una plantilla de Javadoc:

public int doAction(int i) { 
    return i; 
} 

presionar Shift-Alt-J en la declaración de método da:

/** 
* @param i 
* @return 
*/ 
public int doAction(int i) { 
    return i; 
} 
+22

En una Mac, es 'alt-alt-J' – SteveEdson

+2

¡Acabas de hacer que mi vida sea mucho mejor! Te agradeceré cada vez que use shift-alt-J, ¡y cada vez luzco brillante cuando se lo muestro a tus compañeros de trabajo! – Redboots

Cuestiones relacionadas