BSL003 - Неэкспортные методы в областях ПрограммныйИнтерфейс и СлужебныйПрограммныйИнтерфейс¶

Кратко¶

Неэкспортные методы в областях ПрограммныйИнтерфейс и СлужебныйПрограммныйИнтерфейс

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

Поле	Значение
Код правила	`BSL003`
Совместимый псевдоним	`NonExportMethodsInApiRegion`
Серьёзность	`INFORMATION`
Без конфигурации	Да
BSLLS JSON, режим `ON` без переопределений	Да
Флаг реестра `implemented`	Да
Теги	`design`, `api`

Флаг implemented отражает реестр и не подтверждает проверенное совпадение с BSLLS.

Поведение¶

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL003"]
ignore = ["NonExportMethodsInApiRegion"]

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

noqa:

Значение = "пример";  // noqa: BSL003

bsl-disable (совместимый вариант):

Значение = "пример";  // bsl-disable: BSL003

совместимый BSLLS-вариант:

Значение = "пример";  // BSLLS:NonExportMethodsInApiRegion-off

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

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

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

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

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

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

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

Раздел «Программный интерфейс» содержит экспортные процедуры и функции, предназначенные для использования другими объектами конфигурации или другими программами (например, через внешнее соединение).
Раздел «Служебный программный интерфейс» предназначен для модулей, которые являются частью некоторой функциональной подсистемы. В нем должны быть размещены экспортные процедуры и функции, которые допустимо вызывать только из других функциональных подсистем этой же библиотеки.

Источники¶

Структура модуля