MissingVariablesDescription.md

Все объявления переменных должны иметь описание (MissingVariablesDescription)

Тип	Поддерживаются языки	Важность	Включена по умолчанию	Время на исправление (мин)	Теги
Дефект кода	BSL OS	Незначительный	Да	1	standard

Описание диагностики

Все переменные модулей, а также все экспортируемые переменные должны иметь комментарии.

Примеры

Неправильно:

Перем Контекст;

Правильно:

Перем Контекст; // Некое подробное описание, которое объясняет назначение переменной

// Некое подробное описание, которое объясняет назначение переменной
Перем Контекст;

Источники

• Источник: Соглашения при написания кода. Структура модуля

Сниппеты

Экранирование кода

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

Параметр конфигурационного файла

"MissingVariablesDescription": false