强制代码注释助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_b8893874/comment-ls。
技能介绍
代码注释缺失带来的维护痛点
在团队协作或长期迭代的代码库中,新增或修改代码时往往容易忽略注释的补充。这导致后续维护时,开发者难以快速理清 script 中的函数逻辑、template 的模块结构以及 TypeScript 的类型定义。缺乏规范的注释不仅增加了阅读成本,还容易在修改链路中引入隐性 bug。
强制化的注释补齐机制
本技能将注释补充视为代码改动的核心交付约束,而非可选的后期优化。一旦触发代码修改,它会强制介入并执行以下关键步骤:
- 模块判定与规划:在动手写代码前,先评估当前改动涉及的具体功能模块。
- 同步补齐说明:在编写或调整代码时,同步为
template模块、script分块、函数备注以及 TypeScript 类型声明添加简短直接的中文说明。 - 交付前校验:在结束改动前,逐项核对注释的完整性,确保没有遗漏。
适用边界与执行注意点
该技能专注于注释规范的强制执行,不会主动重构已有的代码结构。在实际使用中,需注意以下几点:
- 保持风格一致:注释风格必须与当前文件的现有约定保持统一。
- 拒绝冗余解释:注释应简短直接,说明用途或关键逻辑即可,严禁编写与代码语义重复的逐行解释。
- 上下文依赖:除注释规范外,其余执行习惯需继续遵循
frontend-global的相关约定。
使用场景
- 在 Vue/React 项目中新增组件时,为 template 分块和 script 函数同步补齐中文注释
- 修改 TypeScript 类型定义时,为新增的类型模块和分类型补充清晰的中文说明
- 重构前端逻辑时,确保每个函数和方法都附带简短的用途或关键逻辑备注
- 新增变量定义时,补充类型声明和一行直接的中文用途说明
适合人员
- 前端工程师:在团队协作中修改 Vue/React 组件时,需要确保代码注释符合统一规范
- 全栈开发者:维护跨项目代码库时,需要在 TypeScript 类型和函数中保持一致的注释风格
- 代码审查者:需要检查 PR 中新增代码是否包含完整的模块分隔和函数备注
- 技术负责人:制定团队注释规范时,需要一套可强制执行的自动化检查方案