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

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

  • Тип: Дефект кода
  • Важность: Важный
  • Включена по умолчанию: Да
  • Теги: standard, badpractice

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

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

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

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

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

Примеры

Источники

Соответствие стандартам

Источник диагностики