Missing spaces to the left or right of operators + - * / = % < > <> <= >=, keywords, and also to the right of , and ; (MissingSpace)¶
Type | Scope | Severity | Activated by default |
Minutes to fix |
Tags |
---|---|---|---|---|---|
Code smell |
BSL OS |
Info |
Yes |
1 |
badpractice |
Parameters¶
Name | Type | Description | Default value |
---|---|---|---|
listForCheckLeft |
String |
List to check for the space to the left of (separated by space) |
`` |
listForCheckRight |
String |
List to check for the space to the right of (separated by space) |
, ; |
listForCheckLeftAndRight |
String |
List to check for the space from both sides of (separated by space) |
+ - * / = % < > <> <= >= |
checkSpaceToRightOfUnary |
Boolean |
Check for space to the right of unary signs (+ -) |
false |
allowMultipleCommas |
Boolean |
Allow several commas in a row |
false |
Description¶
To improve code readability to the left and right of operators + - * / = % < > <> <= >=
there must be spaces. Also, the space should be to the right of ,
и ;
Examples¶
Incorrect
Procedure Sum(Param1,Param2)
If Param1=Param2 Then
Sum=Price*Quantity;
EndIf;
EndProcedure
Correct
Procedure Sum(Param1, Param2)
If Param1 = Param2 Then
Sum = Price * Quantity;
EndIf;
EndProcedure
Using checkSpaceToRightOfUnary
parameter¶
The parameter makes sense only in case the unary operator is listed in one of three base parameters.
If set to false
А = -B; // Correct
А = - B; // Correct
If set to true
А = -B; // Incorrect
А = - B; // Correct
Using allowMultipleCommas
parameter¶
The parameter has sense only if ,
is listed in one of three base parameters Defaults to false
If set to false
CommonModuleClientServer.MessageToUser(MessageText,,,, Cancel); // Bad
CommonModuleClientServer.MessageToUser(MessageText, , , , Cancel); // Correct
If set to true
CommonModuleClientServer.MessageToUser(MessageText,,,, Cancel); // Correct
CommonModuleClientServer.MessageToUser(MessageText, , , , Cancel); // Correct
Snippets¶
Diagnostic ignorance in code¶
// BSLLS:MissingSpace-off
// BSLLS:MissingSpace-on
Parameter for config¶
"MissingSpace": {
"listForCheckLeft": "",
"listForCheckRight": ", ;",
"listForCheckLeftAndRight": "+ - * / = % < > <> <= >=",
"checkSpaceToRightOfUnary": false,
"allowMultipleCommas": false
}