[Java] Creare documentazione programma

[andbin]

Devo consegnare un programma Java come esame universitario. Tale programma deve occuparsi della gestione di un magazzino di un negozio d'abbigliamento.
Quali sono le linee guida per creare una buona documentazione? C'è un esempio che posso seguire, uno standard?

Intendi la documentazione "javadoc" (come questa del framework standard)? O altro?

La documentazione javadoc è fondamentale quando si sviluppa ad esempio una "libreria" che dovrà essere usata da altri sviluppatori. Ma se si fa una applicazione finita, a sé stante, una documentazione javadoc generalmente è meno importante. Ma si può comunque fare se ci sono parti rilevanti che rappresentano una API interna che deve essere spiegata in dettaglio.