首页/开发/代码质量与评审速查/检查豁免的注释规范
规范与静态检查65 条

检查豁免的注释规范

豁免必须可审计:禁用指令按行、注明规则名与原因、附上跟踪链接(issue/工单),禁止无说明的整文件关闭;定期复查豁免列表,防止长期累积。

原则按行 > 按文件;注明规则与原因
跟踪关联 issue 或整改时间
复核定期清理过期豁免

写法对照

写法对照
# 反例
eslint-disable

# 正例
eslint-disable-next-line no-explicit-any -- 第三方 SDK 未提供类型,见 QIQI-123
豁免也是技术债条目:登记在案,随模块重构一并消化。

易错点

  • 整文件 disable 无原因:后人不敢删也不知道为什么存在
  • 豁免无期限:临时措施固化,问题永久沉积

数据来源与参考

  • ESLint 文档(禁用规则)、SonarQube 文档(问题豁免流程)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌