Отсутствует описание возвращаемого значения функции (MissingReturnedValueDescription)¶
| Тип | Поддерживаются языки |
Важность | Включена по умолчанию |
Время на исправление (мин) |
Теги |
|---|---|---|---|---|---|
Дефект кода |
BSLOS |
Важный |
Да |
5 |
standardbadpractice |
Параметры¶
| Имя | Тип | Описание | Значение по умолчанию |
|---|---|---|---|
allowShortDescriptionReturnValues |
Булево |
Разрешить краткое описание возвращаемого значения |
true |
Описание диагностики¶
Описание метода (процедуры или функции) должно оформляться корректно, помогая программистам правильно использовать функциональность.
Описание функции должно содержать описание возвращаемого значения в одноименном блоке. Необходимо привести описание для всех возможных типов возвращаемого значения.
Диагностика обнаруживает типовые ошибки:
- Отсутствие описания возвращаемого значения
- Наличие описания возвращаемого значения у процедуры
- Некачественное описание возвращаемого значения: когда имя типа присутствует в описании, но не указано его описание
- Для активации этой, более строгой проверки, необходимо снять разрешение краткой формы записи параметром диагностики
Примеры¶
Источники¶
- Источник: Стандарт: Описание процедур и функций
Сниппеты¶
Экранирование кода¶
// BSLLS:MissingReturnedValueDescription-off
// BSLLS:MissingReturnedValueDescription-on
Параметр конфигурационного файла¶
"MissingReturnedValueDescription": {
"allowShortDescriptionReturnValues": true
}