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

BSL024 — Пробел в начале комментария

← Все правила

Кратко

Пробел в начале комментария

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL024"]
ignore = ["SpaceAtStartComment"]

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

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

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

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

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

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

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

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

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

Между символами комментария "//" и текстом комментария должен быть пробел.

Исключением из правила являются комментарии-аннотации, т.е. комментарии начинающиеся с определенной последовательности символов.

Источники