È possibile ottenere avvisi da javadoc quando manca qualcosa nei commenti javadoc?

Question

Per sbaglio potrei dimenticare di descrivere alcuni parametri o il lancio di eccezioni (o qualcos'altro) durante la documentazione di metodi o classi, ecc.

È possibile eseguire javadoc in modo tale da avvisarmi della mancanza di elementi della documentazione?

(Uso lo script ant per generare documentazione)

Answer 1

Usa Checkstyle ! Ha una formidabile integrazione con Ant e supporta anche centinaia di altri controlli importanti sul tuo codice sorgente.

Il JavadocType checker è ciò di cui avrai bisogno.

Answer 2

Non conosco alcuna opzione javadoc che emetterà un avviso su articoli non documentati.

Tuttavia, se ti capita di usare Eclipse, dai un'occhiata alle impostazioni in

Finestra - > Preferenze - > Java - > Compilatore - > Javadoc

Lì, puoi dire a Eclipse di emettere avvisi su articoli non documentati.

Answer 3

Abbiamo usato Doc Check Doclet per un progetto precedente. Può essere integrato con la build e genera report utili che indicano quale codice ha una scarsa documentazione.

NOTA: lo strumento è beta e non è più supportato da Sun.

Answer 4

Sì, in Eclipse hai incorporato il controllo di tutto ciò che definisci, quindi è possibile mettere questo mancante in " avvertenze " e poi sarai in grado di vedere dove commetti errori.