SA0164: Mehrzeilige Kommentare

Funktion

Ermittelt Codestellen, an denen der Mehrzeilenkommentar-Operator (* *) verwendet wird. Erlaubt sind nur die beiden Einzeilenkommentar-Operatoren // für Standardkommentare und /// für Dokumentationskommentare.

Begründung

Einige Programmierrichtlinien verbieten mehrzeilige Kommentare im Code, weil Anfang und Ende eines Kommentars aus dem Blickfeld geraten könnten und die schließende Kommentarklammer durch einen Fehler gelöscht werden könnte.

Wichtigkeit

Niedrig

PLCopen-Regel

C5

SA0164: Mehrzeilige Kommentare 1:

Sie können diese Prüfung mit dem Pragma {analysis ...} deaktivieren, auch für Kommentare im Deklarationsteil.

Beispiele:

(*
This comment leads to error:
"SA0164 …"
*)
PROGRAM MAIN
VAR
    /// Documentation comment not reported by SA0164
    nCounter1: DINT;
    nCounter2: DINT;             // Standard single-line comment not reported by SA0164 
END_VAR
(* This comment leads to error: "SA0164 …" *)
nCounter1 := nCounter1 + 1;
nCounter2 := nCounter2 + 1;