Best Practices and Guidelines

​

General Best Practices

​

• Always use genvar for generate loop variables

​

• Always provide unique labels for generate blocks

​

• Use parameters for generate conditions

​

• Include default in generate case

​

• Document what each configuration does

​

• Keep generate blocks simple and readable

​

Naming Conventions

​

• Use descriptive labels: adder_gen not g1

​

• Use _gen suffix for generate loops

​

• Use meaningful names for genvar: i, j, k or bit, stage

​

Common Pitfalls to Avoid

​

• Don't use reg/wire as loop variable - use genvar

​

• Don't forget begin:label end blocks

​

• Don't use non-constant expressions in conditions

​

• Don't create generate without generate/endgenerate keywords

​

• Don't reuse label names in the same module

 

Common Mistakes and Solutions

​

Mistake #1: Missing Labels