2011-01-13 22 views

Respuesta

6

Javadoc generación (la escritura de los archivos .html) está hecho para usted bajo demanda (Herramientas> Generar Javadoc) y es esencialmente automática una vez que lo creó. Generar javadoc stubs, que es lo que hace jautodoc para Eclipse, se hace método por método, clase por clase y solo donde se lo indique.

escribiendo /** <enter> encima de un método signature creará stubs Javadoc para usted. Sospecho que quieres algo que haga esto para todo un archivo, paquete o proyecto (como jautodoc). Solía ​​haber un plugin como este: http://plugins.intellij.net/plugin/?id=952 pero no funcionará con 10.

Tengo que decir que este ejemplo de jautodoc, aunque es un buen truco para fiestas, es lo más inútil que he visto en mi vida. un IDE: crea una descripción basada en el nombre de la variable, pero solo si el nombre de la variable es tan descriptivo que no necesita un comentario en primer lugar.

/** 
* The number of questions 
*/ 
private int numberOfQuestions; 

Hace que anhele la tarjeta perforada.

+5

Algunos sistemas de construcción usan checkstyle, jalopy etc. Terminan requiriendo que la gente agregue los javadocs cojos. La mejor práctica es hacer que su código hable por sí mismo, pero cuando está atascado creando problemas de datos debido a su política corporativa que lo requiere, entonces las funciones similares a jautodoc son agradables de tener. ctrl alt j y eres bueno para comprometerte. – branchgabriel