Suspicious use of &ChangeAndValidate (SuspiciousChangeAndValidate)¶

Type	Scope	Severity	Activated by default	Minutes to fix	Tags
`Code smell`	`BSL`	`Major`	`Yes`	`5`	`badpractice` `suspicious`

Description¶

Suspicious use of &ChangeAndValidate (SuspiciousChangeAndValidate)¶

Diagnostic description¶

A method annotated with &ChangeAndValidate contains both #Delete / #EndDelete and #Insert / #EndInsert directives, indicating full method body replacement that hides changes from reviewers.

&ChangeAndValidate is designed for targeted modifications. For full replacement, use &Instead.

Examples¶

Incorrect¶

&ChangeAndValidate("ConfigurationMethod")
Procedure prefConfigurationMethod()

#Delete
    old code
#EndDelete
#Insert
    new code
#EndInsert

EndProcedure

Correct¶

// Targeted changes
&ChangeAndValidate("ConfigurationMethod")
Procedure prefConfigurationMethod()
    ... // original code

#Delete
    problematic line
#EndDelete
#Insert
    fixed line
#EndInsert

    ... // rest of code
EndProcedure

// Or full replacement via &Instead
&Instead("ConfigurationMethod")
Procedure prefConfigurationMethod()
    new code
EndProcedure

Snippets¶

Diagnostic ignorance in code¶

// BSLLS:SuspiciousChangeAndValidate-off
// BSLLS:SuspiciousChangeAndValidate-on

Parameter for config¶

"SuspiciousChangeAndValidate": false