Steeltoe icon indicating copy to clipboard operation
Steeltoe copied to clipboard

Address S3874: "out" and "ref" parameters should not be used

Open bart-vmware opened this issue 3 years ago • 0 comments

Address existing violations of S3874: "out" and "ref" parameters should not be used in the codebase and set severity to Warning in Steeltoe.Debug.ruleset and Steeltoe.Release.ruleset.

To find existing violations, enable the rule (see above) and rebuild src/Steeltoe.All.sln to make them appear in the Output window.

To address the violations, choose from the following on a case-by-case basis:

  • Return a compound object or a tuple, unless the method implements the TryParse pattern
  • Suppress the violation in code using #pragma warning disable/restore, preceded by a justification comment if not obvious

bart-vmware avatar Jul 28 '22 13:07 bart-vmware