Comment Rules¶
comment_004¶
This rule checks for at least a single space before inline comments.
Refer to Configuring Whitespace Rules for options on changing the number of whitespaces..
Violation
wr_en <= '1';--Write data
rd_en <= '1'; -- Read data
Fix
wr_en <= '1'; --Write data
rd_en <= '1'; -- Read data
comment_010¶
This rule checks the indent lines starting with comments.
Violation
-- Libraries
libary ieee;
-- Define architecture
architecture rtl of fifo is
-- Define signals
signal wr_en : std_logic;
signal rd_en : std_Logic;
begin
Fix
-- Libraries
libary ieee;
-- Define architecture
architecture rtl of fifo is
-- Define signals
signal wr_en : std_logic;
signal rd_en : std_Logic;
begin
comment_011¶
This rule checks for in-line comments and moves them to the line above. The indent of the comment will be set to the indent of the current line.
Note
This rule is disabled by default.
Violation
a <= b; -- Assign signal
Fix
-- Assign signal
a <= b;
comment_100¶
This rule checks for a single space after the –.
Violation
--Comment 1
--|Comment 2
---Comment
---------------------------
Fix
-- Comment 1
--| Comment 2
--- Comment
---------------------------