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

BSL202 — Неверное использование "СтрШаблон"

← Все правила

Кратко

Неверное использование "СтрШаблон"

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

Поле Значение
Код правила BSL202
Совместимый псевдоним IncorrectUseOfStrTemplate
Серьёзность ERROR
Включено по умолчанию Да
Реализовано Да
Теги correctness

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL202"]
ignore = ["IncorrectUseOfStrTemplate"]

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

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

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

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

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

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

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

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

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

При использовании метода СтрШаблон нужно внимательно составлять шаблонную строку и передавать правильное количество параметров. И можно довольно легко ошибиться при передаче значений для СтрШаблон.

Важно помнить, что - СтрШаблон принимает только параметры от %1 до %10 - если требуется передать сразу после шаблона число, нужно добавить скобки - "%(1)45"

Примеры

Вариант 1 - количество переданных после шаблонной строки значений не равно (меньше или больше) максимальному номеру из строки вида %N внутри шаблонной строки

  • СтрШаблон("Наименование (версия %1)"); // не передан необходимый параметр для %1
  • СтрШаблон("%1 (версия %2)", Наименование); // не передан необходимый параметр для %2

Вариант 2 - не передается вообще никаких значений, кроме форматированной строки из-за большого количества скобок внутри несложного выражения с НСтр и СтрШаблон:

  • СтрШаблон(НСтр("ru='Наименование (версия %1)'", Версия()));

Здесь ошибочно не закрыта скобка для НСтр. В итоге выражение после вычисления НСтр становится пустым. Выявить подобную ошибку чтением кода довольно сложно из-за наличия скобок. И можно поймать только в рантайме, получив исключение.

Правильный вариант - СтрШаблон(НСтр("ru='Наименование (версия %1)'"), Версия());

Вариант 3 - правильный пример передачи цифр сразу после шаблонного значения - СтрШаблон("Наименование %(1)2"), Наименование); // если передать значение "МояСтрока", то результат будет "МояСтрока2"

Источники