See this page for the VHDL equivalent
Sigasi can check that header comments match specified patterns. A header comment is a comment associated with a declaration or file. A file header comment starts at the first character of the file (no leading whitespace). Documentation generation details how comments are associated with declarations. Only header comments on files are currently supported.
More information on header comment checking and naming conventions is available on the general Linting page.
Note that the entire comment is checked, including comment characters (// or /* */).
Your patterns must also handle these characters.
Since Sigasi Studio 4.4, the raw string of the header comment is checked to allow for maximum compliance checking.
This means that when a new line is matched, users should use \r?\n to ensure the naming conventions work on all platforms.
Rule configuration
These rules can be disabled for your project, or their severity and parameters can be modified in the project linting settings. Alternatively, they can be manually configured using one of the following templates, depending on the type of project you use.
For Modular Projects, add these entries to your project's
.sigasi/settings.jsonsettings file. To scope the settings to a specific folder or file instead of the whole project, place them inside an@overrideblock; to scope them to a specific target, place them inside a@targetsblock.JSONC{ "verilog.rules.22.severity": "{ERROR|WARNING|INFO|IGNORE}", "verilog.rules.22.parameters.comment_header": { "valid": "${regex}", "invalid": "${regex}" } }For Classic Projects, add the VHDL lines to
.settings/com.sigasi.hdt.vhdl.linting.prefsand the Verilog/SystemVerilog lines to.settings/com.sigasi.hdt.verilog.linting.prefs:PREFS22/severity/${path}={error|warning|info|ignore} 22/params/comment_header/${path}=${regex} ${regex}