Utilizzo Javadoc su progetti reali

Lo uso sempre. Mi è utile perché viene visualizzato nel mio IDE mentre digito "." per una chiamata di metodo o quando si passa il mouse su una chiamata o una classe. È molto più facile e veloce di fare clic su un elemento e leggere il codice sorgente per determinare che cosa fa una chiamata nel mondo. Nel suo ruolo inteso come strumento di documentazione API, brilla.

Di solito non uso la documentazione web generata durante la codifica; tuttavia, se sto cercando di ottenere una panoramica di un progetto (gerarchie, ambiti, ecc.), posso generarlo.

I javadoc tutti i membri pubblici e ti incoraggio a fare lo stesso. Tieni presente che il fatto che la documentazione sia presente non significa che sia buona. Dipende da te.

JavaDoc è usato di routine ma:

1) Non sempre completo

2) Spesso non aggiornato con il codice

3) Anche se presente, non sempre letto.

L'ultimo è un problema molto serio: se qualcosa non è evidente dalla firma (ad es. sorpresa, assunzione, limitazione, ecc.), documentarlo non è sufficiente perché è molto probabile che non venga letto. (Vedi la mia discussione su questo problema in (domanda SO correlata) )

L'ho trovato divertente ma non molto utile per il codice normale. Se stavo creando il codice da condividere, genererei i javadocs.

I Javadoc sono buoni solo come i commenti da cui sono stati ricavati; se i commenti non ci sono o sono aggiornati, javadoc porta poco che il completamento automatico non lo farà.