Metriche: commenti vs API documentata

1

Mi è stato chiesto di eseguire alcune metriche del codice per valutare la qualità del codice. Una delle metriche è stata vagamente specificata come "commenti".

Ho eseguito Sonar sul mio codice, e mentre ho ottenuto il 10% sulla metrica "commenti / loc ratio", ho ottenuto il 50% sulla metrica "documented API" (che fornisce il numero di metodi / classi / variabili di istanza con commenti javadoc).

Cercherò di convincere il gestore e il cliente che la metrica "API documentata" è più rilevante della prima nella stima della qualità del codice, in particolare che l'obiettivo della metrica è valutare la capacità di manutenzione del progetto nel caso un altro team ha preso.

Hai studi / opinioni su quale di queste due metriche è più rilevante per valutare la qualità e la manutenibilità del codice? Potrei usarli come strumenti di persecuzione. Grazie

    
posta H-H 28.06.2011 - 19:07
fonte

1 risposta

3

Nessun studio formale, ma alcuni pensieri su questo.

  • Le metriche sul codice e i commenti raramente ti dicono qualcosa di utile
  • Il codice veramente bello e di facile lettura richiede pochi commenti
  • Le API pubbliche per il consumo di terze parti dovrebbero essere ben documentate, anche se i metodi sono abbastanza auto esplicativi

Quindi direi: assicurati che l'API pubblica sia coperta e fai una rapida scansione del codice per vedere se i commenti extra sono applicati in modo appropriato (es. Quando c'è una parte di codice complicata o una strana regola aziendale da spiegare) .

    
risposta data 28.06.2011 - 19:27
fonte

Leggi altre domande sui tag