|
|
|
![]() |
|
Strumenti |
![]() |
#1 |
Member
Iscritto dal: Mar 2004
Città: Milano
Messaggi: 107
|
Giustificazione dei commenti
Salve a tutti.
Volevo chiedervi se conoscete dei tool che in automatico "giustificano i commenti" presenti nel codice. Vi spiego con un esempio (in java, ma solo perchè in questo periodo sto programmando con questo linguaggio): da questo Codice:
/** * Permette di ottenere una tabella contenente tutti i dettagli * sui servizi installati. * * La tabella e' un'istanza di HashMap avente come chiavi i nomi * dei servizi e come valori corrispondenti i bean InstalledService * contenenti i dettagli dei singoli servizi. * @return La tabella contenente i dettagli sui servizi installati * oppure <i>null</i> nel caso qualcosa sia andato storto nel recupero * delle informazioni. */ public HashMap<String, InstalledService> getServicesHashMap() { database.Access database_access = new database.Access(); return database_access.getServicesHashMap(); } Codice:
/** * Permette di ottenere una tabella contenente tutti i dettagli * sui servizi installati. * * La tabella e' un'istanza di HashMap avente come chiavi i nomi * dei servizi e come valori corrispondenti i bean InstalledService * contenenti i dettagli dei singoli servizi. * @return La tabella contenente i dettagli sui servizi installati * oppure <i>null</i> nel caso qualcosa sia andato storto nel recupero * delle informazioni. */ public HashMap<String, InstalledService> getServicesHashMap() { database.Access database_access = new database.Access(); return database_access.getServicesHashMap(); } ![]() Come vedete i commenti sono già in formato javadoc quindi per favore non ditemi "ma che te ne fai della giustificazione, tanto poi quando generi la documentazione non cambia niente?": è solo per mantenere un po' più leggibile il codice (anche se lo so benissimo che giustificato non è equivalente a più leggibile... gli occhi anzi il giustificato non lo gradiscono molto) Grazie.
__________________
Non c'è la morte... c'è la Forza... |
![]() |
![]() |
![]() |
Strumenti | |
|
|
Tutti gli orari sono GMT +1. Ora sono le: 15:45.