注释掉的代码¶

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

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

注释掉的代码会分散开发人员阅读周围代码的注意力，并造成混淆，其重要性通常也不明确。当周围代码发生更改时，注释掉的代码不会被编译或测试，因此很可能随着时间的推移而失效。出于这些原因，应避免使用注释掉的代码。

建议¶

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

参考资料¶

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

©GitHub, Inc.
条款
隐私