FIXME 注释¶

ID: cpp/fixme-comment
Kind: problem
Security severity: 
Severity: recommendation
Precision: very-high
Tags:
   - maintainability
   - documentation
   - external/cwe/cwe-546
Query suites:
   - cpp-security-and-quality.qls

单击查看 CodeQL 仓库中的查询

指示的注释是 FIXME 注释。 FIXME 注释通常用于指示代码无法正常工作或可能无法在所有受支持的环境中工作。这在实现新功能期间可能很有必要，但 FIXME 注释不应出现在稳定代码中。应尽快审查任何 FIXME 注释并改进代码，以避免部分实现的功能累积。

建议¶

修复注释中指示的功能。如果注释不再适用，请将其删除，以避免混淆。

示例¶

int isEven(int n) {
	//FIXME: Is only correct for small values of n
	return n == 0 || n == 2;
}

参考资料¶

维基百科：注释标签
反对 TODO（和 FIXME）的理由
常见漏洞枚举：CWE-546.

©GitHub, Inc.
条款
隐私