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

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

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

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

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

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

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

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

Примеры

Источники

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

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