Si può creare automaticamente i tag Javadoc per un intero progetto di Eclipse?

Question

Lo so si può usare ' J' per creare tag per un elemento singolo codice (metodo di classe, per esempio).

Ma c'è un modo per creare automaticamente questi tag per ogni classe in tutto il progetto? O anche solo a livello di pacchetto o di classe?

Answer 1

Hai guardato JAutodoc ?

Answer 2

Non che io sappia.

Che cosa sarebbe un bene per ogni caso? commenti Javadoc generati automaticamente sono peggio che inutili; Preferirei non li ho ingombrano il mio codice, e javadoc fornire quante più informazioni anche senza commento presente.

Answer 3

automatico generato JavaDoc è un dolore, perché altre persone non ora ciò che il metodo dovrebbe fare e voi stessi potranno anche non lo sanno, quando si guarda alla classe un anno dopo.

Si prega di commentare i vostri metodi da soli o non commentare il metodo.

La mia azienda sta usando checkstyle per costringere i datori di lavoro per aggiungere javadoc. Alcuni datori di lavoro l'odiano per commentare i loro metodi e basta digitare commenti sensless. Sarebbe meglio che il loro non è un commento che una inutile.

Con checkstyle si possono trovare tutti i metodi non documentati, per documentare in un formato ben.

Quello che vi aiuterà a documentare un metodo init come

  

"init deve essere chiamata prima di qualsiasi   altro metodo e inizializza la classe   ActionDummy "

è meglio dire che cosa esattamente viene fatto

  

: Inizializza lo stato di default del   fornitore di azione. Alcune variabili di stato possono essere   sovresposta da chi ascolta quando ....