☰
  • 首页
  • 规则分类
  • 项目介绍
search
•••

关注 TODO、FIXME、XXX、BUG 等特殊注释

3.5.3 ID_specialComment
目录 › next › previous

TODO、FIXME、XXX、BUG 等特殊注释表示代码中存在问题,这种问题不应被遗忘,应有计划地予以解决。

及时记录问题是一种好习惯,而且最好有署名和日期。

示例:

void foo() {
    /*
     * Some plans...         // Bad, easy to forget
     */
}

void foo() {
    /* TODO:
     * Some plans...  -- my name, date     // Good
     */
}

审计工具不妨定期搜索这些关键词对应的注释,以供相关人员核对问题解决情况。

配置

specialCommentPatterns: 特殊注释的模式字符串(如正则表达式等),供审计工具查找

参考

CWE-546
Copyright©2024 360 Security Technology Inc., Licensed under the Apache-2.0 license.