Skip to content

Space at the beginning of the comment (SpaceAtStartComment)

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

Parameters

Name Type Description Default value
commentsAnnotation String Skip comments-annotations staring with given substrings. List, values separated by comma //@,//(c),//©
useStrictValidation Boolean Use strict validation against double comments//// Comment`` true

Description

Between comment symbols "//" and comment text has to be a space.

Exception from the rule is comments-annotations, comments starting with special symbols sequence.

Sources

Snippets

Diagnostic ignorance in code

// BSLLS:SpaceAtStartComment-off
// BSLLS:SpaceAtStartComment-on

Parameter for config

"SpaceAtStartComment": {
    "commentsAnnotation": "//@,//(c),//©",
    "useStrictValidation": true
}