Inaccurate Source Code Comments

Opis

The source code contains comments that do not accurately describe or explain aspects of the portion of the code with which the comment is associated.

Skutki

• Other

  Reduce Maintainability

  This issue makes it more difficult to maintain the product, which indirectly affects security by making it more difficult or time-consuming to find and/or fix vulnerabilities. It also might make it easier to introduce vulnerabilities.

• Other

  Increase Analytical Complexity

  When a comment does not accurately reflect the associated code elements, this can introduce confusion to a reviewer (due to inconsistencies) or make it more difficult and less efficient to validate that the code is implementing the intended behavior correctly.

Zapobieganie

• Implementation

  Verify that each comment accurately reflects what is intended to happen during execution of the code.

Słabość nadrzędna

• CWE-1078 Inappropriate Source Code Style or Formatting

Kiedy powstaje

• Implementation

Dotyczy

Not Language-Specific

Źródła

1. Providing a Framework for Effective Software Quality Assessment — Robert A. Martin, Lawrence H. Shafer, 1996