Domande con tag 'javadocs'

domande con tag
6
risposte

Codice auto-documentante vs Javadocs?

Recentemente ho lavorato sul refactoring di parti della base di codice con cui sto trattando attualmente - non solo per capirlo meglio da me, ma anche per facilitare gli altri che stanno lavorando sul codice. Tendo a pensare che il codice di...
posta 30.11.2011 - 11:00
3
risposte

Come documentare API sperimentali o incomplete come @deprecated?

Esiste un termine valido che è simile ma diverso da "deprecate" per indicare che un metodo o un'API si trova nella base del codice ma non dovrebbe essere utilizzato perché la sua implementazione non è completa o probabilmente cambierà? (Sì, lo s...
posta 15.10.2012 - 21:38
2
risposte

Deprecato contro Denigrato in JavaDoc?

Nel JavaDoc per X509Certificate getSubjectDN() indica: Denigrated, replaced by getSubjectX500Principal(). Sono abituato a vedere Deprecato in per i metodi che non dovrebbero essere più utilizzati, ma non Denigrati. Ho trovat...
posta 02.11.2012 - 19:07
1
risposta

Come mantenere aggiornati gli esempi di codice in javadoc

Sto lavorando su una piccola libreria che fornisce implementazioni di metriche di base e ben note. Principalmente per la mia educazione. Quindi lo sviluppo accade ogni volta che ho un po 'di tempo libero. Per questo motivo ho automatizzato la...
posta 10.08.2015 - 17:30
2
risposte

Modo ASCIUTTO per scrivere Javadoc sui metodi di sovraccarico

Voglio scrivere Javadoc in modo ASCIUTTO. Ma il documento dell'oracolo su Javadoc dice di scrivere di nuovo la stessa cosa nel metodo di overload commento. Non posso evitare la ripetizione?     
posta 13.01.2012 - 03:25
3
risposte

La lettura di javadoc è preferibile alla lettura del codice sorgente per familiarizzare con una libreria?

Ho appena trovato quanto segue in un manuale di laboratorio all'università: You do need to study the interfaces of the classes by generating the javadoc for them so you know what operations are provided (feel free to look at the code, but...
posta 04.02.2015 - 14:28
1
risposta

Documentazione del codice Java in un file docs separato mappato in qualche modo su un file sorgente?

Quale sarebbe una buona alternativa alla documentazione in linea Java, cioè si può avere un file docs separato in qualche modo mappato su un file sorgente java? Non mi sono mai piaciute le sezioni di commenti enormi disseminate nel codice.  ...
posta 29.10.2012 - 14:03
1
risposta

Formato di documentazione del codice standardizzato, dov'è? [chiuso]

Attualmente sto esaminando gli strumenti di generazione di documentazione API e ho notato che apparentemente non ci sono sforzi in corso nella standardizzazione. Lo stile Javadoc è una specie di convenzione onnipresente ... è usato per Java...
posta 08.05.2012 - 03:51
3
risposte

Porting library, cosa fare con commenti / crediti JavaDoc

Ho portato una libreria su Java, ma mi sto chiedendo cosa fare con i commenti di JavaDoc. Anche la libreria originale utilizzava commenti javadoc, quindi lascio i tag @author dal codice originale? E come faccio a darmi credito come la persona ch...
posta 14.01.2012 - 03:34
1
risposta

Java Doc - Anche i campi vengono documentati?

Questa è una domanda molto semplice, ma stranamente, trovo difficile ottenere una risposta definitiva .... Che cosa fai con i campi? È valido? /** * Keeps track of all usernames in the system. */ private List<String> usernames =...
posta 24.12.2014 - 16:26