Ingegneria software javadocs

6

Recentemente ho lavorato sul refactoring di parti della base di codice con cui sto attualmente trattando - non solo per capirlo meglio da solo, ma anche per renderlo più facile per gli altri che stanno lavorando al codice. Tendo a appoggiarmi al lato di pensare che il codice di auto-documentazione …

18 java documentation refactoring javadocs

3

Come documentare API sperimentali o incomplete come @deprecated?

Esiste un buon termine simile ma diverso da "deprecato" per indicare che un metodo o API è nella base di codice ma non deve essere utilizzato perché la sua implementazione non è completa o probabilmente cambierà? (Sì, lo so, quei metodi non dovrebbero essere pubblici, yada yada yada. Non ho …

12 documentation terminology api documentation-generation javadocs

2

Obsoleto contro denigrato in JavaDoc?

In JavaDoc per X509Certificate getSubjectDN()esso afferma: Denigrato , sostituito da getSubjectX500Principal (). Sono abituato a vedere deprecato nei metodi for che non dovrebbero più essere usati, ma non denigrati. Ho trovato un bug report su questo caso particolare in cui è stato chiuso con un commento: Questo non è un …

11 java terminology javadocs

1

Come mantenere aggiornati gli esempi di codice in javadocs

Sto lavorando a una piccola libreria che fornisce implementazioni di metriche di stringa di base ben note. Principalmente per la mia educazione. Quindi lo sviluppo avviene ogni volta che ho un po 'di tempo libero. Per questo motivo ho automatizzato la maggior parte dei processi in modo da poter rilasciare …

9 java documentation javadocs

2

Modo DRY per scrivere Javadoc su metodi di sovraccarico

Voglio scrivere Javadoc in modo SECCO. Ma il documento dell'oracolo su Javadoc dice di scrivere di nuovo la stessa cosa nel commento del metodo di sovraccarico. Non posso evitare la ripetizione?

9 documentation comments dry javadocs

Domande taggate «javadocs»