bslls:MissingVariablesDescription¶

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

• Тип: Дефект кода
• Важность: Незначительный
• Включена по умолчанию: Да
• Теги: standard

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

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

Примеры¶

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

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

Правильно:

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

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

Источники¶

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

Соответствие стандартам¶

• #std455, п. 2.2: Структура модуля — Диагностика «Все объявления переменных должны иметь описание (MissingVariablesDescription)» проверяет условие пункта 2.2 стандарта std455.

Источник диагностики¶

• Исходная статья
• Ревизия: f4616cda8a216789ee40529ed857e614b9e2ea25
• Лицензия: LGPL-3.0-or-later