generador de plantillas Javadoc

Question

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 llena los huecos que quedan

¿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.

Answer 1

El plug-in para Eclipse JAutodoc hace exactamente lo que necesita, pero con una granularidad paquete:

haga clic derecho en un paquete, seleccionar "Añadir Javadoc para los miembros ..." y se añadirá el esqueleto.

Existen numerosas opciones interesantes: plantillas para javadoc, la adición de un TODO en la cabecera de cada archivo que dice: "plantilla javadoc, se debe llenar ...", etc.

Answer 2

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.

Answer 3

Puede configurar Eclipse para mostrar advertencias para cosas que carecen de javadoc, o tienen 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 solicitó, pero probablemente sea mejor porque no terminará con esqueletos vacíos en los métodos que se olvidó.

Puede lograr esto investigando y editando la página de preferencias más allá de la ruta Ventana> Preferencias> Java> Compilador> Javadoc para su área de trabajo. La captura de pantalla de la página de preferencias es el siguiente:

Para más información acerca de los artículos en esta pantalla por favor siga el siguiente enlace:

Java Compiler Javadoc Preferences Help

Answer 4

creo Javadoc vacío generación de auto-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.

Recomendaría, en cambio, que configure su editor de código para que lo ayude, por método y por clase, a utilizar cuando realmente escribe el javadoc (un comentarista señaló que la función de Eclipse lo hace).

Answer 5

También puede colocar el cursor en la línea por encima de un método que le gustaría a JavaDoc, a continuación, escriba:

/** 

y pulse Intro. Esto generará su código JavaDoc.

Answer 6

Seleccione el método de que desea añadir 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; 
    }