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

BSL031 — Ограничение на количество параметров метода

← Все правила

Кратко

Ограничение на количество параметров метода

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

Поле Значение
Код правила BSL031
Совместимый псевдоним NumberOfParams
Серьёзность WARNING
Включено по умолчанию Да
Реализовано Да
Теги design, brain-overload

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL031"]
ignore = ["NumberOfParams"]

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

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

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

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

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

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

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

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

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

Не рекомендуется объявлять в функциях много параметров (нужно ориентироваться на количество не более семи параметров), при этом не должно быть много параметров со значениями по умолчанию (нужно ориентироваться на количество не более трех таких параметров). В противном случае, читаемость вызывающего кода сильно снижается. Например, можно легко ошибиться в количестве запятых при передаче необязательных параметров.

При необходимости передавать в функцию большое число параметров рекомендуется группировать однотипные параметры в один или несколько составных параметров типа Структура.

Примеры

Неправильно:

// Создает элемент справочника "Номенклатура"
Процедура СоздатьЭлементНоменклатуры(Наименование, ТоварУслуга, ЕдиницаИзмерения, ВесНетто, ПроверятьУникальность = Истина)

КонецПроцедуры

Правильно: Cгруппировать параметры, описывающие значения реквизитов номенклатуры, в структуру ЗначенияРеквизитов.

// Создает элемент справочника "Номенклатура"
Процедура СоздатьЭлементНоменклатуры(ЗначенияРеквизитов, ПроверятьУникальность = Истина)
КонецПроцедуры

Источники