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

BSL002 - Ограничение на размер метода

← Все правила

Кратко

Ограничение на размер метода

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

Поле Значение
Код правила BSL002
Совместимый псевдоним MethodSize
Серьёзность ERROR
Без конфигурации Да
BSLLS JSON, режим ON без переопределений Да
Флаг реестра implemented Да
Теги size, brain-overload

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

Поддерживаемые параметры

TOML BSLLS JSON По умолчанию
max-proc-lines maxMethodSize 200

Ключи TOML задаются в [tool.onec-hbk-bsl], ключи JSON в diagnostics.parameters.MethodSize.

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL002"]
ignore = ["MethodSize"]

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

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

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

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

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

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

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

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

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

Существуют громоздкие методы (процедуры и функции), с которыми невозможно эффективно работать именно из-за их огромного размера. Большой метод зачастую возникает, когда разработчик добавляет в метод новый функционал. "Зачем мне выносить проверку параметров в отдельный метод, если я могу написать ее тут?", "Для чего необходимо выделять метод поиска максимального элемента в массиве, оставим его тут. Так код яснее", - и прочие заблуждения.

Есть два правила рефакторинга большого метода:

  • Если при написании метода хочется добавить комментарий в код, необходимо выделить этот функционал в отдельный метод
  • Если метод занимает более 50-100 строк кода, следует определить задачи и подзадачи, которые он выполняет, и попробовать вынести подзадачи в отдельный метод

Источники