Date: 1/1/2020Category: 编程技术Tag: 代码注释, IDE
一、完整注释表格
| 注释名 | 核心作用说明 | 适用场景细分 | VSC | VS | JetBrains | 优先级建议 |
|---|---|---|---|---|---|---|
| TODO | 功能未实现(尚未启动开发) | 新需求、未动工的模块 / 接口 | [x] | [x] | [x] | 中 - 高 |
| TODO:HIGH/MID/LOW | 带优先级的未实现功能 | 需区分紧急程度(如 HIGH = 迭代必做,LOW = 后续优化) | [] | [] | [x] | 自定义 |
| UNDONE | 功能未完成(已开发部分,待收尾) | 开发中被打断、需补充细节 / 边界处理的功能 | [] | [x] | [] | 中 |
| FIXME | 已发现明确 Bug,需修复 | 可复现、定位清晰的缺陷(含潜在风险未复现的问题) | [] | [] | [x] | 高 |
| FIXME:URGENT | 紧急 Bug 修复 | 线上故障、阻塞测试的核心流程缺陷 | [] | [] | [x] | 最高 |
| BUG | 已确认的具体缺陷 | 区别于 FIXME:更侧重 “已复现 + 影响范围明确” 的 Bug(如 “用户 ID>1000 时查询失败”) | [] | [] | [] | 高 |
| HACK | 临时解决方案 / 取巧实现 | 功能可用,但代码不优雅(如硬编码、规避框架限制),待重构 | [] | [x] | [] | 中 |
| XXX | 待优化问题(设计 / 实现不规范) | 非紧急缺陷,如命名不规范、冗余代码、逻辑可简化(优先级低于 HACK/FIXME) | [] | [] | [] | 低 - 中 |
| UnresolvedMergeConflict | 未解决的代码合并冲突 | Git 合并分支时产生的冲突,需手动对比处理 | [] | [x] | [] | 最高 |
| NOTE | 重要说明 / 备注 | 记录设计思路、依赖条件、使用限制(如 “依赖第三方 SDK v2.3.0,升级需改签名”) | [] | [] | [x] | - |
| DEPRECATED | 已废弃的代码 / 接口 | 不建议继续使用,后续版本会删除(需标注替代方案) | [] | [] | [x] | - |
| REVIEW | 需代码审查 / 复核 | 复杂逻辑、高风险模块(如权限控制、支付流程),需团队复核 | [] | [] | [] | 中 |
| OPTIMIZE | 性能 / 结构优化 | 代码可运行,但效率低(如 O (n²) 循环)或结构混乱,需重构 | [] | [] | [] | 低 - 中 |
