Do not use Optional on ref or out. parameters

Documentos > Code Analysis > Static Analysis Rules > Do not use Optional on ref or out. parameters

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: csharp-best-practices/optional-ref-out

Language: C#

Severity: Info

Category: Best Practices

Description

The modifier Optional should not be used on ref or out parameters because it’s semantically incorrect:

an out parameter is used as a value to return from the function and, therefore, is not optional
a ref parameter is passed back to the caller

Non-Compliant Code Examples

class MyClass {

    public static void routine([Optional] out i)
    {
    }
}

class MyClass {
    public static void routine([Optional] ref int i)
    {
    }

}

How to use this rule

1
2
rulesets:
  - csharp-best-practices     # Rules to enforce C# best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products