Métrique : Taux de commentaires du code source

Description de l’utilisateur

Les commentaires peuvent aider les développeurs à comprendre ce que fait le code, à quelle fin et de quelle manière.

Cette métrique calcule le rapport (Unité : %) entre CLOC (Comment Lines Of Code) et SLOC (Source Lines Of Code) de la partie implémentation d'un objet.

CLOC : Nombre de lignes de commentaire, y compris les lignes combinant code source et commentaire.

SLOC : Nombre de lignes sans commentaires et de lignes vides, y compris les lignes combinant code source et commentaire.

Calcul de mesure

Chaque ligne d'un objet implémenté textuel (fonction (FUN), bloc fonction (FB), type d'unité de données (DUT), programme (PRG), etc.) est vérifiée pour déterminer si elle contient un commentaire ou du code source.

La métrique fournit le rapport entre ces deux valeurs.

Exemple

Exemple de calcul du taux de commentaires du code source :

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();

Résultat du taux de commentaires du code source : 50 %