Qual è una buona lunghezza per Javadoc per una classe che è lunga 800 righe?

5

Sto facendo una revisione del codice sul codice di qualcuno per classe.

La classe è lunga circa 800 righe, contiene una dozzina di funzioni ma la descrizione è lunga 1 riga.

Mi chiedo, in generale, per quanto tempo dovrebbe essere la descrizione di una classe? (in Java)?

    
posta Leo Ufimtsev 26.11.2012 - 01:32
fonte

2 risposte

9

Abbastanza a lungo per documentare adeguatamente la classe.

Secondo Oracle , la documentazione di classe adeguata include:

  • Executive summary - Una descrizione precisa e concisa dell'oggetto.
  • Informazioni sullo stato : consente di specificare le informazioni sullo stato associate all'oggetto, descritte in un modo che disaccoppia gli stati dalle operazioni che possono richiedere o modificare questi stati.
  • Dipendenze hardware / OS : specifica l'eventuale dipendenza dal sistema operativo o dall'hardware sottostante. Vedi l'esempio.
  • Varianze di implementazione consentite : specifica in che modo qualsiasi aspetto di questo oggetto può variare in base all'implementazione.
  • Vincoli di sicurezza - Se l'oggetto presenta vincoli o restrizioni di sicurezza, è necessario fornire una panoramica di tali vincoli e restrizioni nella specifica della classe.

  • Riferimenti a qualsiasi Specifiche esterna : si tratta di specifiche di classe scritte da Sun o da terze parti oltre a quelle generate da Javadoc.

risposta data 26.11.2012 - 01:41
fonte
2

Il Javadoc per ciascun metodo dovrebbe spiegare perché questo metodo è nella classe; quello che realizza. Javadoc per la classe stessa dovrebbe spiegare perché la classe esiste, inclusa una sinossi di ciò che fa e una descrizione di qualunque essa sia rappresentata da quelle istanze di quella classe.

    
risposta data 26.11.2012 - 02:39
fonte

Leggi altre domande sui tag