159 lines
2.4 KiB
ReStructuredText
159 lines
2.4 KiB
ReStructuredText
Comment Rules
|
|
-------------
|
|
|
|
comment_001
|
|
###########
|
|
|
|
This rule aligns comments above library use statements with the use statement.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
library ieee;
|
|
-- Use standard logic library
|
|
use ieee.std_logic_1164.all;
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
library ieee;
|
|
-- Use standard logic library
|
|
use ieee.std_logic_1164.all;
|
|
|
|
comment_004
|
|
###########
|
|
|
|
This rule checks for at least a single space before inline comments.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en <= '1';--Write data
|
|
rd_en <= '1'; -- Read data
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
wr_en <= '1'; --Write data
|
|
rd_en <= '1'; -- Read data
|
|
|
|
comment_005
|
|
###########
|
|
|
|
This rule aligns consecutive comment only lines above a **when** keyword in a case statement with the **when** keyword.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
when wr_en =>
|
|
rd_en <= '0';
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
when wr_en =>
|
|
rd_en <= '0';
|
|
|
|
comment_008
|
|
###########
|
|
|
|
This rule aligns consecutive comment only lines above the **elsif** keyword in if statements.
|
|
These comments are used to describe what the elsif code is going to do.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
elsif (a = '1')
|
|
rd_en <= '0';
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
elsif (a = '1')
|
|
rd_en <= '0';
|
|
|
|
comment_009
|
|
###########
|
|
|
|
This rule aligns consecutive comment only lines above the **else** keyword in if statements.
|
|
These comments are used to describe what the elsif code is going to do.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
else
|
|
rd_en <= '0';
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- comment 1
|
|
-- comment 2
|
|
-- comment 3
|
|
else
|
|
rd_en <= '0';
|
|
|
|
comment_010
|
|
###########
|
|
|
|
This rule checks the indent lines starting with comments.
|
|
|
|
**Violation**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- Libraries
|
|
libary ieee;
|
|
|
|
-- Define architecture
|
|
architecture RTL of FIFO is
|
|
|
|
-- Define signals
|
|
signal wr_en : std_logic;
|
|
signal rd_en : std_Logic;
|
|
|
|
begin
|
|
|
|
**Fix**
|
|
|
|
.. code-block:: vhdl
|
|
|
|
-- Libraries
|
|
libary ieee;
|
|
|
|
-- Define architecture
|
|
architecture RTL of FIFO is
|
|
|
|
-- Define signals
|
|
signal wr_en : std_logic;
|
|
signal rd_en : std_Logic;
|
|
|
|
begin
|
|
|
|
|