BSL162 - Пропущен постфикс "Клиент"¶

Кратко¶

Пропущен постфикс "Клиент"

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

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

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

Поведение¶

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL162"]
ignore = ["CommonModuleNameClient"]

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

noqa:

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

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

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

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

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

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

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

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

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

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

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

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

Клиентские общие модули содержат клиентскую бизнес-логику (функциональность, определенную только для клиента) и имеют признаки:

Клиент (управляемое приложение)
Клиент (обычное приложение)

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

Клиентские общие модули именуются с постфиксом "Клиент" (англ. "Client" ). Кроме случая - когда стоит флаг Глобальный.

Примеры¶

РаботаСФайламиКлиент, ОбщегоНазначенияКлиент, StandardSubsystemsClient

Источники¶

Стандарт: Тексты модулей