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

BSL170 — Лишняя директива компиляции

Кратко

Лишняя директива компиляции

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL170"]
ignore = ["CompilationDirectiveNeedLess"]

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

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

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

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

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

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

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

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

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

Директивы компиляции:

&НаКлиенте (&AtClient)
&НаСервере (&AtServer)
&НаСервереБезКонтекста (&AtServerNoContext)

Следует применять только в коде модулей управляемых форм и в коде модулей команд. В остальных модулях рекомендуется применять инструкции препроцессору.

В серверных или клиентских общих модулях контекст исполнения очевиден, поэтому смысла в директивах компиляции нет. В общих модулях с признаками клиент и сервер применение директив компиляции затрудняет понимание, какие же процедуры (функции) доступны в конечном итоге.

Источники