BSL211 — Имена объектов метаданных не должны превышать допустимой длины наименования¶

Кратко¶

Имена объектов метаданных не должны превышать допустимой длины наименования

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

Поле	Значение
Код правила	`BSL211`
Совместимый псевдоним	`MetadataObjectNameLength`
Серьёзность	`WARNING`
Включено по умолчанию	Да
Реализовано	Да
Теги	`naming`, `convention`

Поведение¶

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL211"]
ignore = ["MetadataObjectNameLength"]

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

noqa:

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

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

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

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

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

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

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

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

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

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

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

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

Имена объектов метаданных не должны превышать 80 символов.

Кроме проблем с использованием этих объектов возникают проблемы с выгрузкой конфигурации в файлы.

Примеры¶

ОченьДлинноеИмяСправочникиКотороеВызываетПроблемыВРаботеАТакжеОшибкиВыгрузкиКонфигурации, LooooooooooooooooooooooooooooooooooooooooooooooooooooooooongVeryLongDocumentName

Источники¶

Стандарт: Имя, синоним, комментарий