Metrisch: Commented Variables (All) Ratio

Benutzerbeschreibung

Diese Metrik berechnet das Verhältnis (Einheit: %) zwischen kommentierten und nicht kommentierten Variablen in einem Objekt.

Metrikberechnung

Jede Variablendeklaration in Objekten (Funktion (FUN), Funktionsbaustein (FB), Dateneinheitstyp (DUT), Globale Variablenliste (GVL) usw.) wird geprüft, ob sie kommentiert ist oder nicht.

Das Verhältnis zwischen diesen zwei Werten wird mit dieser Metrik bereitgestellt.

Beispiel

Beispiel für die Berechnung des kommentierten Variablenverhältnisses:

Declaration:
1: PROGRAM SR_Main
2: VAR
3:     xCheck1: BOOL;//flag to identify
4:     uiMyVariable2: UINT;
5:     xFlag: BOOL;
6: END_VAR

Ergebnis der Metrik „Commented Variables (All) Ratio“: 33,33 %