Metrica: rapporto commenti codice sorgente

Descrizione utente

I commenti possono aiutare gli sviluppatori a capire ciò che fa il codice, lo scopo e la modalità di funzionamento.

Questa metrica calcola il rapporto (Unità: %) tra CLOC (Comment Lines Of Code) e SLOC (Source Lines Of Code) della parte di implementazione di un oggetto.

CLOC: numero di righe di commento, incluse le righe con codice sorgente e commento.

SLOC: numero di righe senza commenti e righe vuote, incluse le righe con codice sorgente e commento.

Calcolo metrica

Ogni riga in un oggetto testuale implementato (funzione (FUN), blocco funzione (FB), Tipo unità dati (DUT), programma (PRG) e così via) viene verificata per la presenza di commenti o codice sorgente.

Il rapporto tra questi due valori è fornito con questa metrica.

Esempio

Esempio di calcolo del rapporto commenti codice sorgente:

1:
2: IF (x = TRUE) THEN
3:     DoSomething();//This is very important and hard to understand
4: END_IF
5:
6: // A nice comment
7: SpecialMethod();

Risultato rapporto commenti codice sorgente: 50%