¿Es fácil agregar un bloque de comentarios (estilo Javadoc) a cada método en un proyecto de Eclipse y posiblemente a clases para que pueda completarlas más tarde?¿Cómo agregar un bloque de comentarios a los métodos en Eclipse?
Según lo sugerido, puede hacerlo por método-por-método (Fuente -> Generar elemento de comentario) o ALT+SHIFT+J pero me parece una muy mala idea. Los comentarios solo son útiles cuando brindan información adicional. Cuando sientas que se necesita más información, agrégalo.
Tener comentarios sobre los setters como "establece el valor" o peor aún, los comentarios generados automáticamente que no son del todo útiles.
+1; la generación automática de documentos para * todo * es definitivamente contraproducente debido al exceso de ruido. –
Este método agrega bloques de comentarios a variables de clase y métodos. Sin embargo, solo agrega un/* */normal en la parte superior de cada método sin otros detalles. Recuerdo usar el programa para agregar comentarios de estilo PHPdoc a cada función en proyectos de PHP con muchos detalles. De todos modos, gracias por la respuesta. –
El tipo de comentarios "establece el valor" en realidad empeora la legibilidad del código. –
Bajo
Ventana | Preferencias | Java | Estilo de código | Plantillas de código
se encuentran 2 características:
Puede editar el bloque de comentarios generado mediante el uso de variables de eclipse o su texto de Javadoc estático.
¿De qué manera puedo aplicar el método de comentario en el código fuente? Por ejemplo, en (Fuente -> Generar comentario de elemento), podríamos generarlo para decir el comentario de la clase, ¿hay alguna manera rápida en que podríamos tener "Generar comentario de método". – user454083
Quizás esté interesado en este
Para añadir un comentario sobre el método seleccione getUser o lleve el cursor antes getUser y presione ALT + SHIFT + J Se agregará el comentario sobre su método
/*
* @param
* @return User
*/
public User getUser();
utilice estos pasos y lo hará fácilmente. en eclipse ve a Proyecto -> genera javadoc -> presiona enter y luego selecciona tu proyecto para ser documentado.
Usuarios de Mac: ^ - ⌥ - J
Usuarios de Windows: Shift - Alt - J
PS: Asegúrese de que ha instalado el plugin JAutodoc
es cosa simple, sólo tiene que teclear/** y presiona Enter en la parte superior del método, en el que desea generar comentario .it genera de forma automática el elemento comentario. No es necesario ir por mucho Key ins.
Sí, puede hacer clic derecho en una declaración de método, luego hacer clic en 'Fuente> Generar comentario de elemento'. Sin embargo, no es una buena idea agregar la documentación más tarde ... esto nunca funciona. ¡Documente cada método antes de implementarlo o al menos inmediatamente después de implementarlo! – home
Me di cuenta de eso, pero mejor tarde que nunca :) –