Skip to content

BSL013 — Commented out code

← All rules

Summary

Commented out code

Identifiers

Field Value
Rule code BSL013
Compatible alias CommentedCode
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags unused

Behavior

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

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

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

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

Software modules should not have commented out code fragments, as well as fragments, which are in any way connected with the development process (debugging code, service marks, i.e. !!! _, MRG, etc.) and with specific developers of this code.

For example, it is unacceptable to leave such fragments in the code after debugging or refactoring is completed:

Procedure BeforeDelete(Failure)
    //If True Then
    //  Message("For debugging");
    //EndIf;
EndProcedure
also wrong: 
Procedure BeforeDelete(Failure)
    If True Then
        // Ivanov: need fix
    EndIf;
EndProcedure

Correct: after debugging or refactoring is completed, remove the handler BeforeDelete from the code.

ATTENTION: A code block is considered commented, if at least one line inside the block is defined as code.

Sources