Javadoc Generare Documentazione

[Daikin]

Salve a tutti , sono alle prese con un progetto Java e sto creando la documentazione.
Ho formattato anche il codice per la documentazione come richiesto , però non riesco a generare le pagine html.
Mi date qualke suggerimento.

Grazie


Uso NetBeans 6.8 ( Linux - Ubuntu )

[andbin]

Originariamente inviato da Daikin
Salve a tutti , sono alle prese con un progetto Java e sto creando la documentazione.
Ho formattato anche il codice per la documentazione come richiesto , però non riesco a generare le pagine html.
Mi date qualke suggerimento.

Avevo fatto un esempio molto basilare in questo post.

[Daikin]

Grazie

già avevo aggiunto un pò di commenti ( con la formattazione da te indicata ) però non riuscivo a generare i file .html

Con NetBeans ( ho risolto ) Esegui --> Generate JavaDoc

Funziona !!!!! che figata

solo che non riesco ad inserire nella Documentazione alcuni metodi generati automaticamente da NetBeans
( esempio le azioni dei bottoni ) sono per default privati e non ci sono nella documentazione
( non posso metterli pubblici perchè netBeans blocca l'editazione del codice )

Suggerimenti per risolvere questo problema ?

[andbin]

Originariamente inviato da Daikin
Con NetBeans ( ho risolto ) Esegui --> Generate JavaDoc

solo che non riesco ad inserire nella Documentazione alcuni metodi generati automaticamente da NetBeans
( esempio le azioni dei bottoni ) sono per default privati e non ci sono nella documentazione
( non posso metterli pubblici perchè netBeans blocca l'editazione del codice )

Suggerimenti per risolvere questo problema ?

Premesso che javadoc di norma, tipicamente, serve per documentare la API "pubblica" di un framework, libreria ecc...
Quindi se un membro è private, nessuno lo "sa" che c'è e d'altronde dall'esterno non si potrebbe nemmeno usarlo.

Il tool "javadoc" del JDK ha delle opzioni -public / -protected / -package / -private che consentono di scegliere il livello minimo da mostrare. Per default l'opzione è -protected, vuol dire che javadoc documenta solo ciò che è protected/public.

Un IDE che offre dialog/wizard per invocare il tool javadoc del JDK dovrebbe anche permettere la selezione di questa opzione. Eclipse ce l'ha, NetBeans non lo so perché non lo conosco. Verifica.

Tuttavia ricorda cosa ho detto all'inizio. E comunque sappi che javadoc non può documentare proprio tutto. Ad esempio le "anonymous inner class" no.