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?Originariamente inviata da anto892
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.
Andrea, andbin.dev – Senior Java developer – SCJP 5 (91%) • SCWCD 5 (94%)
java.util.function Interfaces Cheat Sheet — Java Versions Cheat Sheet
Devo creare un'applicazione finita per la gestione di un magazino di un negozio d'abbigliamento( con associata anche la base dati in SQL), chiedevo se c'erano delle linee guida da seguire per una documentazione scritta ad esempio se si deve fare una sorta di documento word, anche perchè il professore ha richiesto un sequence diagram e un class diagram oltre che una descrizione dell'interfaccia grafica (non ricordo il nome sono alle prime armi, perdono!!)
Rispondi quotando
