Métrique : Nombre de lignes de commentaire en en-tête

Description de l’utilisateur

Cette métrique compte le nombre de commentaires dans l'en-tête de la section de déclaration.

Ces commentaires peuvent aider les développeurs à comprendre ce que fait l'objet considéré, à quelle fin et de quelle manière.

Calcul de mesure

Chaque ligne de commentaire apparaissant dans l'en-tête d'une section de déclaration d'un objet IEC (fonction (FUN), bloc fonction (FB), type d'unité de données (DUT), liste de variables globales (GVL), etc.) est comptabilisée.

Exemple

Exemple de calcul des commentaires d'en-tête :

Declaration:
1: //This PRG is the start point
2: //Methodes:
3: // - ....
4: // - ....
5: PROGRAM SR_Main
6: VAR
7:     x: BOOL;
8: END_VAR

Résultat du calcul des commentaires d'en-tête : 4