Check comments for wording issues

Documentos > Code Analysis > Static Analysis Rules > Check comments for wording issues

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

Language: TypeScript

Severity: Notice

Category: Code Style

Description

Check the variable names and suggest better names.

Examples of replacement suggestions:

blacklist with denylist
whitelist with allowlist
master with primary
slave with secondary

Non-Compliant Code Examples

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

// she SHE should check her code

// he should check his

Compliant Code Examples

// allowlist names to prevent unauthorized usage

/* the comments do not have a history of issues */

How to use this rule

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