MissingReturnedValueDescription.md

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

Тип	Поддерживаются языки	Важность	Включена по умолчанию	Время на исправление (мин)	Теги
Дефект кода	BSL OS	Важный	Да	5	standard badpractice

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

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

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

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

• Отсутствие описания возвращаемого значения
• Наличие описания возвращаемого значения у процедуры
• Некачественное описание возвращаемого значения: когда имя типа присутствует в описании, но не указано его описание

Примеры

Источники

• Источник: Стандарт: Описание процедур и функций

Сниппеты

Экранирование кода

// BSLLS:MissingReturnedValueDescription-off
// BSLLS:MissingReturnedValueDescription-on

Параметр конфигурационного файла

"MissingReturnedValueDescription": false