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

BSL065 — Отсутствует описание возвращаемого значения функции

← Все правила

Кратко

Отсутствует описание возвращаемого значения функции

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

Поле Значение
Код правила BSL065
Совместимый псевдоним MissingReturnedValueDescription
Серьёзность INFORMATION
Включено по умолчанию Да
Реализовано Да
Теги design, documentation

Поведение

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

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

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

[tool.onec-hbk-bsl]
select = ["BSL065"]
ignore = ["MissingReturnedValueDescription"]

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

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

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

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

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

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

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

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

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

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

Описание функции должно содержать описание возвращаемого значения в одноименном блоке. Необходимо привести описание для всех возможных типов возвращаемого значения.

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

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

Примеры

Источники