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

Кратко¶

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

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

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

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

Поведение¶

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL163"]
ignore = ["CommonModuleNameClientServer"]

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

noqa:

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

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

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

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

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

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

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

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

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

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

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

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

Для того чтобы избежать дублирования кода, рекомендуется создавать клиент-серверные общие модули с теми процедурами и функциями, содержание которых одинаково на сервере и на клиенте. Такие процедуры и функции размещаются в общих модулях с признаками:

Клиент (управляемое приложение)
Сервер (флажок Вызов сервера сброшен)
Клиент (обычное приложение)
Внешнее соединение

Общие модули этого вида именуются с постфиксом "КлиентСервер" (англ. "ClientServer").

Примеры¶

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

Источники¶

Стандарт: Правила создания общих модулей