Skip to content

BSL171 - Crazy multiline literals

← All rules

Summary

Crazy multiline literals

Identifiers

Field Value
Rule code BSL171
Compatible alias CrazyMultilineString
Severity INFORMATION
Without configuration Yes
BSLLS JSON, ON mode without overrides Yes
Registry flag implemented Yes
Tags style, readability

The implemented flag describes the registry; it does not certify verified BSLLS parity.

Behavior

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

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

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

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

In source text, multi-line constants can be initialized in two ways:

  • 'classic', which uses line feed and string concatenation
  • 'crazy' where lines are separated by whitespace

The second method complicates the perception; when using it, it is easy to make and miss a mistake.

Examples

Difficulty understanding:

String = "BBB" "CC"
"F";

Classic variant:

String = "BBB" + "CC"
         + "F";

Sources