Перейти к содержанию

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

← Все правила

Кратко

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

Идентификаторы

Поле Значение
Код правила BSL219
Совместимый псевдоним MissingVariablesDescription
Серьёзность INFORMATION
Включено по умолчанию Да
Реализовано Да
Теги documentation, convention

Поведение

  • Публичный идентификатор BSL219 и псевдоним MissingVariablesDescription стабильны.
  • Правило сообщает о случаях, описанных на этой странице.
  • Подавления и проектная конфигурация применяются до публикации результата.
  • Для выполнения правила не требуется внешний анализатор или сетевой доступ.

Настройка и подавление

Код BSL### — основной стабильный идентификатор. Совместимый псевдоним принимается в select, ignore и совместимых блоковых комментариях.

[tool.onec-hbk-bsl]
select = ["BSL219"]
ignore = ["MissingVariablesDescription"]

Все три семейства подавлений работают для текущей строки и диапазона. Если открывающий комментарий стоит после кода, он действует только на эту строку. Используйте любой один вариант:

  • noqa:
Значение = "пример";  // noqa: BSL219
  • bsl-disable (совместимый вариант):
Значение = "пример";  // bsl-disable: BSL219
  • совместимый BSLLS-вариант:
Значение = "пример";  // BSLLS:MissingVariablesDescription-off

Если тот же открывающий комментарий стоит на отдельной строке, он начинает диапазон. Закройте его парным маркером того же семейства:

// noqa: BSL219
// код без этой диагностики
// noqa-enable: BSL219

// bsl-disable: BSL219
// код без этой диагностики
// bsl-enable: BSL219

// BSLLS:MissingVariablesDescription-off
// код без этой диагностики
// BSLLS:MissingVariablesDescription-on

Чтобы отключить правило до конца файла, не добавляйте закрывающий noqa-enable, bsl-enable или BSLLS:…-on.

Открывающий и закрывающий маркеры должны принадлежать одному семейству.

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

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

Примеры

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

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

Правильно:

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

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

Источники