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

BSL215 - Отсутствует описание параметров метода

← Все правила

Кратко

Отсутствует описание параметров метода

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

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

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

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL215"]
ignore = ["MissingParameterDescription"]

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

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

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

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

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

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

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

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

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

Описание метода (процедуры или функции) должно оформляться корректно, помогая программистам правильно использовать функциональность.

Если метод содержит параметры, то в его описании, в одноименном блоке, должны быть приведены описания для всех параметров в том же порядке, что и в сигнатуре метода.

Диагностика обнаруживает типовые ошибки:

  • Отсутствие описания всех параметров
  • Отсутствие описания части параметров, с указанием, для какого параметра описание не обнаружено
  • Присутствие в описании параметров, отсутстсвующих в сигнатуре метода (которые могли остаться от рефакторинга)
  • Некачественное описание параметра: когда имя параметра присутствует в описании метода, но не указаны тип параметра и описание типа

Примеры

Источники