Skip to content

BSL155 — Method definitions must be placed before the module body operators

← All rules

Summary

Method definitions must be placed before the module body operators

Identifiers

Field Value
Rule code BSL155
Compatible alias CodeBlockBeforeSub
Severity ERROR
Enabled by default Yes
Implemented Yes
Tags error

Behavior

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

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

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

// BSLLS:CodeBlockBeforeSub-off
// code without this diagnostic
// BSLLS:CodeBlockBeforeSub-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 structure of the software module (in general form) is clearly defined:

  • first comes the variable definition block
  • then definitions of procedures and functions
  • then the module code block

Based on the structure described above, the location of the program code before the definition of methods is unacceptable.

Examples

Incorrect

SomeMethod();
Message("Before methods definition");

Procedure SomeMethod()
// Method body
EndProcedure

Sources