All public methods must have a description (PublicMethodsDescription)¶
| Type | Scope | Severity | Activated by default |
Minutes to fix |
Tags |
|---|---|---|---|---|---|
Code smell |
BSLOS |
Info |
Yes |
1 |
standardbrainoverloadbadpractice |
Parameters¶
| Name | Type | Description | Default value |
|---|---|---|---|
checkAllRegion |
Boolean |
Test methods without regard to the areas in which they are located |
false |
Description¶
All export methods in the Public region must have a description.
Sources¶
Snippets¶
Diagnostic ignorance in code¶
// BSLLS:PublicMethodsDescription-off
// BSLLS:PublicMethodsDescription-on
Parameter for config¶
"PublicMethodsDescription": {
"checkAllRegion": false
}