MissingVariablesDescription.md

All variables declarations must have a description (MissingVariablesDescription)

Type	Scope	Severity	Activated by default	Minutes to fix	Tags
Code smell	BSL OS	Minor	Yes	1	standard

Description

All module variables and export variables must have comments.

Examples

Incorrect:

Var Context;

Correct:

Var Context; // Detailed description that explains the purpose of the variable 

// Detailed description that explains the purpose of the variable 
Var Context;

Sources

• Reference: Code conventions. Module structure

Snippets

Diagnostic ignorance in code

// BSLLS:MissingVariablesDescription-off
// BSLLS:MissingVariablesDescription-on

Parameter for config

"MissingVariablesDescription": false