Why is this an issue?

Sharing some naming conventions is a key point to make it possible for a team to efficiently collaborate. This rule allows to check that all local parameter names match a provided regular expression.

How to fix it

Code examples

Noncompliant code example

With default regular expression ^[A-Z]|[A-Z]+[A-Z0-9_]*[A-Z0-9]+$:

module fly
  #(localparam abc = 2); // Noncompliant
  localparam def = 5; // Noncompliant
  localparam JKL = 0;
endmodule : fly

Compliant solution

With default regular expression ^[A-Z]|[A-Z]+[A-Z0-9_]*[A-Z0-9]+$:

module fly
  #(localparam ABC = 2);
  localparam DEF = 5;
  localparam JKL = 0;
endmodule : fly

Resources

Articles & blog posts

• lowRISC Verilog Coding Style Guide - Naming