how - Generador de plantillas Javadoc
javadoc java 8 example (6)
Tengo una gran base de código sin Javadoc, y quiero ejecutar un programa para escribir un esqueleto con la información básica de Javadoc (por ejemplo, para el parámetro de cada método escriba @param ...), así que solo tengo que llenar los vacíos restantes.
Alguien sabe una buena solución para esto?
Editar:
JAutodoc es lo que estaba buscando. Tiene tareas Ant, un plugin de Eclipse y usa Velocity para la definición de la plantilla.
Puede configurar eclipse para mostrar advertencias de cosas que carecen de javadoc, o tener javadoc que no tiene toda la información, o tiene información incorrecta. También puede insertar plantillas para que llene.
No es exactamente la herramienta que pediste, pero probablemente sea mejor porque no terminarás con esqueletos vacíos en los métodos que te perdiste.
Puede lograr esto investigando y editando la página de preferencias más allá de la ruta Ventana> Preferencias> Java> Compiler> Javadoc para su área de trabajo. La captura de pantalla de esa página de preferencias está a continuación:
Para obtener más información acerca de los elementos en esta pantalla, siga el siguiente enlace:
Creo que la autogeneración de Javadoc vacío es un antipatrón y debería desalentarse. le da al código la apariencia de estar documentado, pero solo agrega ruido a la base de código.
En su lugar, recomendaría que configure el editor de código para que lo ayude, por método y por clase, a utilizarlo cuando escriba realmente el javadoc (un comentarista señaló que la característica de Eclipse lo hace).
Si hace clic derecho en el origen de un archivo en Eclipse, tiene una opción de generación de Javadoc en el menú de origen.
El complemento de JAutodoc para eclipse hace exactamente lo que necesita, pero con una granularidad de paquete:
Haga clic derecho en un paquete, seleccione "Agregar javadoc para miembros ..." y se agregará el esqueleto.
Hay numerosas opciones interesantes: plantillas para javadoc, agregando un TODO en el encabezado de cada archivo que dice: "template javadoc, debe llenarse ...", etc.
También puede colocar su cursor en la línea sobre un método que le gustaría JavaDoc, luego escriba:
/**
y presiona Enter. Esto generará su código JavaDoc.
Seleccione el método que desee agregar Javadoc y alt + Shift + j , crea automáticamente el comentario javadoc.
EJEMPLO:
/**
* @param currDate
* @param index
* @return
*/
public static String getAtoBinary(String currDate, int index){
String HourA = "0";
try{
String[] mydate = currDate.split("/");
HourA = mydate[index].substring(1, 2);
}catch(Exception e){
Log.e(TAG, e.getMessage());
}
return HourA;
}