Generatore di modelli Javadoc [chiuso]

Question

Ho una base di codice di grandi dimensioni senza Javadoc e voglio eseguire un programma per scrivere uno scheletro con le informazioni Javadoc di base (ad esempio, per il parametro di ciascun metodo scrivere @param...), quindi devo solo riempire gli spazi vuoti rimasti.

Qualcuno conosce una buona soluzione per questo?

Modificare:

JAutodoc è quello che stavo cercando.Ha attività Ant, un plug-in Eclipse e utilizza Velocity per la definizione del modello.

Answer 1

IL JAutodoc il plugin per eclipse fa esattamente ciò di cui hai bisogno, ma con una granularità del pacchetto:

fare clic con il tasto destro su un pacchetto, selezionare "Aggiungi javadoc per i membri..." e lo scheletro verrà aggiunto.

Ci sono numerose opzioni interessanti:templates per javadoc, aggiungendo un TODO nell'intestazione di ogni file dicendo:"modello javadoc, deve essere compilato...", ecc.

Answer 2

Penso che la generazione automatica di Javadoc vuoto sia un anti-pattern e dovrebbe essere scoraggiato;dà al codice l'apparenza di essere documentato, ma aggiunge semplicemente rumore alla base del codice.

Consiglierei invece di configurare il tuo editor di codice per assisterti in base al metodo e alla classe da utilizzare quando scrivi effettivamente il javadoc (un commentatore ha indicato la funzionalità di Eclipse che fa questo).

Answer 3

Puoi anche posizionare il cursore sulla riga sopra un metodo che desideri JavaDoc, quindi digitare:

/**

e premere Invio.Questo genererà il tuo stub JavaDoc.

Answer 4

Puoi configurare Eclipse per mostrare avvisi per cose che mancano di Javadoc o che Javadoc non contiene tutte le informazioni o contiene informazioni errate.Può anche inserire modelli da compilare.

Non proprio lo strumento che avevi richiesto, ma probabilmente migliore perché non ti ritroverai con scheletri vuoti sui metodi che ti sei perso.

Puoi ottenere questo risultato esaminando e modificando la pagina delle preferenze oltre il percorso Finestra > Preferenze > Java > Compilatore > Javadoc per il tuo spazio di lavoro.Lo screenshot della pagina delle preferenze è riportato di seguito:

Per ulteriori informazioni sugli elementi presenti in questa schermata, seguire il collegamento riportato di seguito:

Guida alle preferenze Javadoc del compilatore Java

Answer 5

Seleziona il metodo che desideri aggiungere Javadoc e alt+Spostare+J, crea automaticamente il commento javadoc.

ESEMPIO:

/**
     * @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

Se fai clic con il pulsante destro del mouse sull'origine di un file in Eclipse, è disponibile un'opzione di generazione Javadoc nel menu sorgente.