CWEweakness

CWE-546 Suspicious Comment

Official page ↗
Abstraction
Base
Structure
Simple
Status
Draft
Languages
Not Language-Specific
CWE version
5.0

Description

The code contains comments that suggest the presence of bugs, incomplete functionality, or weaknesses.

Common consequences

• Other: Quality Degradation — Suspicious comments could be an indication that there are problems in the source code that may need to be fixed and is an indication of poor quality. This could lead to further bugs and the introduction of weaknesses.

Potential mitigations

• [Documentation] Remove comments that suggest the presence of bugs, incomplete functionality, or weaknesses, before deploying the application.

Detection methods

• Automated Static Analysis: Automated static analysis, commonly referred to as Static Application Security Testing (SAST), can find some instances of this weakness by analyzing source code (or binary/compiled code) without having to execute it. Typically, this is done by building a model of data flow and control flow, then searching for potentially-vulnerable patterns that connect "sources" (origins of input) with "sinks" (destinations where the data interacts with external components, a lower layer such as the OS, etc.)

Related

Child of · CWE (1)

  • CWE-1078 Inappropriate Source Code Style or Formatting weakness

Referenced by CWE · has member (1)

Referenced by CWE · peer of (1)

  • CWE-615 Inclusion of Sensitive Information in Source Code Comments weakness