Method parameters description are missing (MissingParameterDescription)¶

Type	Scope	Severity	Activated by default	Minutes to fix	Tags
`Code smell`	`BSL` `OS`	`Major`	`Yes`	`5`	`standard` `badpractice`

Description¶

The description of a method (procedure or function) should be formatted correctly to help programmers use the functionality correctly.

If a method contains parameters, then in its description, in the block of the same name, descriptions for all parameters must be given in the same order as in the method signature.

Diagnostic detects typical errors:

Lack of description of all parameters
Absence of a description of some of the parameters, indicating for which parameter the description was not found
The presence in the description of parameters that are absent in the method signature (which could remain from refactoring)
Poor parameter description: when the parameter name is present in the method description, but the parameter type and type description are not specified

Examples¶

Sources¶

Standart: Procedures and functions description (RU)

Snippets¶

Diagnostic ignorance in code¶

// BSLLS:MissingParameterDescription-off
// BSLLS:MissingParameterDescription-on

Parameter for config¶

"MissingParameterDescription": false