Skip to content

BSL215 — Method parameters description are missing

← All rules

Summary

Method parameters description are missing

Identifiers

Field Value
Rule code BSL215
Compatible alias MissingParameterDescription
Severity INFORMATION
Enabled by default Yes
Implemented Yes
Tags documentation, api

Behavior

  • The public identifier BSL215 and alias MissingParameterDescription are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL215"]
ignore = ["MissingParameterDescription"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL215
  • bsl-disable:
Value = "example";  // bsl-disable: BSL215
  • compatible BSLLS form:
Value = "example";  // BSLLS:MissingParameterDescription-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL215
// code without this diagnostic
// noqa-enable: BSL215

// bsl-disable: BSL215
// code without this diagnostic
// bsl-enable: BSL215

// BSLLS:MissingParameterDescription-off
// code without this diagnostic
// BSLLS:MissingParameterDescription-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

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