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

BSL171 - Безумные многострочные литералы

Кратко

Безумные многострочные литералы

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

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL171"]
ignore = ["CrazyMultilineString"]

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

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

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

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

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

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

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

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

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

В исходном тексте многострочные константы могут задаваться двумя способами:

  • 'классический', в котором используется символ переноса строки и конкатенация строк
  • 'странный', при котором строки разделяются пробельными символами

Второй способ усложняет восприятие, при его использовании проще допустить и пропустить ошибку.

Примеры

Усложняет восприятие:

Строка = "ВВВ" "СС"
"Ф";

Классический вариант:

Строка = "ВВВ" + "СС"
         + "Ф";

Источники