Skip to main content

SA0162: Fehlende Kommentare

Ermittelt nicht kommentierte Stellen im Programm.

Begründung: Eine vollständige Kommentierung wird von vielen Programmierrichtlinien gefordert und erhöht die Lesbarkeit und Wartbarkeit des Codes.

Wichtigkeit: Niedrig

PLCopen-Regel: C2

Kommentare sind erforderlich bei

  • der Deklaration von Variablen. Die Kommentare stehen darüber oder rechts davon.

  • der Deklaration von Programmen, Funktionsbausteinen oder Methoden. Die Kommentar stehen über der Deklaration ( in der ersten Zeile).

Beispiel

PROGRAM PLC_PRG
VAR
        iMaxValue:  INT;
END_VAR

--> SA0162: Kommentar für 'PLC_PRG' fehlt
--> SA0162: Kommentar für 'iMaxValue' fehlt