Ensure comment wording is inclusive

Documentos > Code Analysis > Static Analysis Rules > Ensure comment wording is inclusive

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-inclusive/comments

Language: C#

Severity: Notice

Category: Best Practices

Description

Avoid using words such as blacklist, whitelist, slave or master in comments. Consider using more inclusive wording in your code.

Non-Compliant Code Examples

abstract class Motorcycle
{
    // this is to get a blacklist
    public void Denylist() { }

    protected void AddGas(int denylistNames) {}


}

Compliant Code Examples

abstract class Motorcycle
{
    // this is to get a denylist
    public void Denylist() { }

    protected void AddGas(int denylistNames) {}


}

How to use this rule

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

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