Elenca tutte le classi SENZA Javadoc

Question

C'è un modo semplice per analizzare il codice sorgente per elencare il numero di classi che non hanno javadoc?

Come parte di un esercizio di debito tecnico, voglio elencare tutti questi file e condividere l'elenco tra i membri del team affinché gli autori originali li scrivano.

Nota: Stiamo usando Gradle come sistema di compilazione

UPDATE ... javadocs così vuoto vengono creati per impostazione predefinita, ma i nostri sviluppatori havnt le riempirono in gran parte. Mi piace essere in grado di vedere tutte le classi che non hanno alcuna descrizione nel documento a livello di classe. Non mi preoccupo troppo dei metodi.

Answer 1

Un modo semplice sarebbe utilizzare Checkstyle.

Scarica il file jar e creare un file di configurazione XML (javadoc_checks.xml) come questo:

<module name="Checker"> 
    <module name="TreeWalker"> 
     <module name="JavadocType"/> 
     <module name="JavadocMethod"/> 
     <module name="JavadocVariable"/> 
     <module name="JavadocStyle"/> 
    </module> 
</module> 

Ora eseguire il seguente comando (supponendo che tutto è nella stessa directory e src contiene il codice):

java -jar checkstyle-6.9-all.jar -c javadoc_checks.xml src/ 

Se, ad esempio, si vuole solo verificare la presenza di javadoc per le classi e interfacce mancante, quindi basta questo nel XML di configurazione:

<module name="Checker"> 
    <module name="TreeWalker"> 
     <module name="JavadocType"/> 
    </module> 
</module> 

E l'uscita sarebbe qualcosa di simile:

C:\src\com\example\Test.java:137: Javadoc comment missing. 
C:\src\com\example\Test1.java:3: Javadoc comment missing. 
C:\src\com\example\Test2.java:12: Javadoc comment missing. 

Ci sono un sacco di opzioni, è possibile vedere in:

http://checkstyle.sourceforge.net/config_javadoc.html

http://checkstyle.sourceforge.net/cmdline.html