Check comments for wording issues

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: javascript-inclusive/comments

Language: JavaScript

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 */