SA0162: Fehlende Kommentare

Funktion

Ermittelt Stellen im Programm, die nicht kommentiert sind. Kommentare sind erforderlich bei:

  • der Deklaration von Variablen. Die Kommentare stehen darüber oder rechts davon.
  • der Deklaration von POUs, DUTs, GVLs oder Schnittstellen. Die Kommentare stehen über der Deklaration (in der ersten Zeile).

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

Beispiele:

Das folgende Beispiel erzeugt für die Variable b1 den Fehler: "SA0162: Missing comment for 'b1'".

// Comment for MAIN program
PROGRAM MAIN
VAR
    b1  : BOOL;
    // Comment for variable b2
    b2  : BOOL;
    b3  : BOOL;                  // Comment for variable b3
END_VAR