Skip to main content

SA0163: Nested comments

Detects nested comments

Justification: Nested comments should be avoided because they are difficult to read.

Importance: Low

PLCopen rule: C3

Example 121. Example
{attribute 'do-analysis'}
(* That is
(* nested comment 1 *)
*)
PROGRAM PLC_PRG
VAR
(* That is
// nested comment 2
comment *)
    iVal1: INT;
    iVal2: INT;

(* That is
(* nested comment 3 *) *)
    pVal3: POINTER TO DWORD;
    hugo: INT;
END_VAR

(* That is
// nested comment 4
comment *)
iVal1 := iVal1 + 1;
(* That is
(* nested comment 5 *)
*)

(* Not that one *)

Output in the Messages view:

  • sa_icon_message.png SA0163: Nested comment 'nested comment 1'

  • sa_icon_message.png SA0163: Nested comment 'nested comment 2'

  • sa_icon_message.png SA0163: Nested comment 'nested comment 3'

  • sa_icon_message.png SA0163: Nested comment 'nested comment 4'

  • sa_icon_message.png SA0163: Nested comment 'nested comment 5'



: