注释掉的代码¶

ID: py/commented-out-code
Kind: problem
Security severity: 
Severity: recommendation
Precision: high
Tags:
   - maintainability
   - readability
   - documentation
Query suites:
   - python-security-and-quality.qls

单击查看 CodeQL 代码库中的查询

注释掉的代码会分散开发人员阅读周围代码的注意力，并造成混乱，其意义通常不清楚。当周围的代码发生变化时，它不会被编译或测试，因此随着时间的推移可能会出现问题。出于这些原因，应避免注释掉的代码。

建议¶

删除或恢复注释掉的代码。如果你想在注释中包含一段示例代码，请考虑将其用引号括起来，或以适合源语言的方式进行标记。

示例¶

在以下示例中，一个 print 语句（最初用于调试）保留在代码中，但被注释掉了。它应该完全删除。

def area(r):
    #if DEBUG:
    #   print("Computing area of %r" % r)
    return r.length * r.width

参考¶

Mark Needham: 注释掉代码的危险.
Los Techies: 注释掉的代码 == 技术债务.
高完整性 C++ 编码标准：2.3.2 不要注释掉代码.

©GitHub, Inc.
条款
隐私