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

BSL156 — Код расположен вне области

← Все правила

Кратко

Код расположен вне области

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL156"]
ignore = ["CodeOutOfRegion"]

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

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

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

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

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

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

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

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

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

Весь код модуля должен быть структурирован и разделен по разделам (областям). Требование о разделении кода модуля на разделы призвано повысить читаемость кода и упростить внесение изменений в код разными авторами (разработчиками) как при коллективной разработке, так и при доработке прикладных решений на конкретных внедрениях.

Примеры

#Область <ИмяОбласти>

Несмотря на то, что в стандарте описано всего 10 имён, имена вложенных областей не проверяются.

Правильно: 

#Область СлужебныеПроцедурыИФункции
#Область Печать
// Код процедур и функций
#КонецОбласти
#Область Прочее
// Код процедур и функций
#КонецОбласти
#КонецОбласти

Таблица соответствия английских имён (полный список в исходном коде):

русск. англ.
ПрограммныйИнтерфейс Public
СлужебныйПрограммныйИнтерфейс Internal
СлужебныеПроцедурыИФункции Private
ОбработчикиСобытий EventHandlers
ОбработчикиСобытийФормы FormEventHandlers
ОбработчикиСобытийЭлементовШапкиФормы FormHeaderItemsEventHandlers
ОбработчикиКомандФормы FormCommandsEventHandlers
ОписаниеПеременных Variables
Инициализация Initialize
ОбработчикиСобытийЭлементовТаблицыФормы FormTableItemsEventHandlers

Источники