Metrica: rapporto variabili commentate (In+Out+Globali)

Descrizione utente

Questa metrica calcola il rapporto (Unità: %) tra variabili commentate e non commentate definite in VAR_GLOBAL, VAR_INPUT, VAR_OUTPUT o VAR_IN_OUT

Calcolo metrica

Ogni dichiarazione di variabile negli oggetti (funzione (FUN), blocco funzione (FB), Tipo di unità dati (DUT), Elenco variabili globali (GVL) e così via) viene verificata per la presenza di commenti o meno.

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

Esempio

Esempio di calcolo del rapporto delle variabili commentate (in+out+globali):

Declaration:
1: PROGRAM SR_Main
2: VAR_IN
3:     i_xCheck1: BOOL;//flag to identify
3:     i_uiMyVariable2: UINT;
4: END_VAR
2: VAR
3:     xFlag: BOOL;
4: END_VAR

Risultato del rapporto variabili commentate (in+out+globali): 50%