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