Skip to content

BSL239 — Reserved parameter names

← All rules

Summary

Reserved parameter names

Identifiers

Field Value
Rule code BSL239
Compatible alias ReservedParameterNames
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags naming, suspicious

Behavior

  • The public identifier BSL239 and alias ReservedParameterNames 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 = ["BSL239"]
ignore = ["ReservedParameterNames"]

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: BSL239
  • bsl-disable:
Value = "example";  // bsl-disable: BSL239
  • compatible BSLLS form:
Value = "example";  // BSLLS:ReservedParameterNames-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: BSL239
// code without this diagnostic
// noqa-enable: BSL239

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

// BSLLS:ReservedParameterNames-off
// code without this diagnostic
// BSLLS:ReservedParameterNames-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

If a parameter name matches one of a system enumeration's name, then all values of that enumeration will not be available in the local context. Module code's syntax checking will not detect an error. To prevent this situation, a parameter name should not match all names of system enumerations.

Parameter names should not contain reserved words such as system enumerations. The list of reserved words is set by a regular expression. The search is case-insensitive.

For example:

"FormGroupType|FormFieldType"

Sources