Comment blocks
ID | LAYOUT-1 |
Title | Comment blocks shall not be used. |
Priority | Recommended |
Severity level | 7 |
Description | Comment blocks (with %{ notation) shall not be used. Every first comment on a line shall start with a comment indicator (% or ... ). Use CTRL-R and CTRL-T to comment/uncomment blocks of code. |
Rationale | Consistent comment syntax improves readability. |
Avoid:
%{ This is a comment.
This is also a comment.
%}
Instead use:
% This is a comment.
% This is also a comment.