¿Se puede crear automáticamente las etiquetas Javadoc para un proyecto completo de Eclipse?

StackOverflow https://stackoverflow.com/questions/1136035

Pregunta

Sé que uno puede utilizar ' J' para crear etiquetas para un único elemento de código (método de clase, por ejemplo).

Sin embargo, hay una manera de crear automáticamente las siguientes etiquetas para cada clase en todo el proyecto? O incluso sólo a nivel de paquete o clase?

¿Fue útil?

Solución

¿Has mirado en JAutodoc ?

Otros consejos

No es que yo sepa.

¿Cómo sería bueno para todos modos? autogenerados comentarios Javadoc son más que inútiles; Yo preferiría no tener que estorbar encima de mi código, y Javadoc a proporcionar tanta información incluso sin comentarios presente.

automática genera JavaDoc es un dolor, porque otras personas nunca ahora lo que el método debe hacer y usted mismo tampoco lo sabrán, cuando se mira a la clase un año más tarde.

Por favor, comentar sus métodos por sí mismo o no comentar el método.

Mi empresa está utilizando Checkstyle para obligar a los empleadores para agregar javadoc. Algunos empleadores odian a comentar sus métodos y sólo tiene que escribir los comentarios sensless. Sería mejor que su no hay comentario que un inútil.

Con Checkstyle se pueden encontrar todos los métodos de indocumentados, para documentar en un formato bien.

¿Qué le ayudará a documentar un método init como

  

"init tiene que ser llamado antes de cualquier   otro método e inicializa la clase   ActionDummy "

que es mejor decir lo que se hace exactamente

  

Inizializes el estado por defecto de la   proveedor de acción. Algunas variables de estado pueden ser   anulado por el oyente cuando ....

Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow
scroll top