Use inclusive language in comments

Documentos > Code Analysis > Static Analysis Rules > Use inclusive language in comments

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

Language: Go

Severity: Notice

Category: Best Practices

Description

Use inclusive language in comments.

Non-Compliant Code Examples

/**
 *  whitelist and blacklist names to prevent unauthorized usage
 */

// This app follows the master/slave model

// she SHE should check her code

// he should check his

How to use this rule

1
2
rulesets:
  - go-inclusive     # Rules to enforce Go 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