Generador de plantillas Javadoc [cerrado]

Question

Tengo una base de código grande 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 espacios que quedan.

¿Alguien conoce una buena solución para esto?

Editar:

JAutodoc es lo que estaba buscando.Tiene tareas Ant, un complemento de Eclipse y usa Velocity para la definición de la plantilla.

Answer 1

El JAutodoc El complemento 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.

Existen numerosas opciones interesantes:plantillas para javadoc, agregando un TODO en el encabezado de cada archivo que dice:"plantilla javadoc, debe completarse...", etc.

Answer 2

Creo que la generación automática de Javadoc vacío es un antipatrón y debería desaconsejarse;le da al código la apariencia de estar documentado, pero solo agrega ruido al código base.

En su lugar, recomendaría que configure su editor de código para ayudarlo por método y por clase para usarlo cuando realmente escriba el javadoc (un comentarista señaló la característica de Eclipse que hace esto).

Answer 3

También puede colocar el cursor en la línea sobre el método que desea JavaDoc y luego escribir:

/**

y presione Entrar.Esto generará su código auxiliar de JavaDoc.

Answer 4

Puede configurar eclipse para que muestre advertencias sobre cosas que carecen de javadoc, o que tienen un javadoc que no tiene toda la información o tiene información incorrecta.También puede insertar plantillas para que las complete.

No es exactamente la herramienta que pediste, pero probablemente sea mejor porque no terminarás con esqueletos vacíos de 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 > Compilador > Javadoc para su espacio de trabajo.La captura de pantalla de esa página de preferencias se encuentra a continuación:

Para obtener más información sobre los elementos de esta pantalla, siga el siguiente enlace:

Ayuda de preferencias de Javadoc del compilador Java

Answer 5

Seleccione el método que desea agregar Javadoc y alternativo+Cambio+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;
    }

Answer 6

Si hace clic derecho en la fuente de un archivo en Eclipse, tiene una opción de generación de Javadoc en el menú fuente.