Non export methods in API regions (NonExportMethodsInApiRegion)

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

Parameters

Name	Type	Description	Default value
skipAnnotatedMethods	Boolean	Skip extension annotated methods	false

Description

• The "API Interface" region contains export procedures and functions intended for use by other configuration objects or other programs (for example, via an external connection).

• The “Service Programming Interface” region is intended for modules that are part of some functional subsystem. It should contain export procedures and functions that can only be called from other functional subsystems of the same library.

Sources

• Source: Standard: Module structure (RU)

Snippets

Diagnostic ignorance in code

// BSLLS:NonExportMethodsInApiRegion-off
// BSLLS:NonExportMethodsInApiRegion-on

Parameter for config

"NonExportMethodsInApiRegion": {
    "skipAnnotatedMethods": false
}