AI Skill 大全

代码注释与变更日志审校

读取分支、暂存区或指定路径的新增注释、文档字符串与变更日志,结合代码改写冗余叙述并列出修改结果。

功能与用途

适合提交代码前检查新增说明文字。指定当前分支、暂存区或文件路径后,它会结合周边代码,审查新增注释、文档字符串和变更日志,删除重复代码含义、记录开发经过或验证过程的文字,保留解释当前行为和必要约束的说明,并直接修改文件。变更日志可保留用户可见的新旧行为对比。最后输出问题所在文件与行号、原文及修改结果;没有问题时也会明确告知。使用时需能访问代码仓库及其写作规范。

适用场景

  • 提交前清理新增注释:检查暂存区里的新增注释,删除开发经过和验证叙述,保留对当前代码行为有用的解释。
  • 分支文档字符串审校:审查分支新增的文档字符串,结合函数实现改写过时对比、含混简称和重复说明。
  • 发布日志措辞检查:保留用户可见的行为变化,清除变更日志中的方案争论、评审经过和内部重构叙述。

适用人群

  • 提交代码的软件开发者
  • 审核合并请求的代码维护者
  • 维护开源项目的贡献者

使用步骤

  1. 指定暂存区、当前分支或待审查文件路径。
  2. 读取仓库写作规范及新增文字周边的代码。
  3. 检查新增说明是否准确描述当前行为。
  4. 直接改写或删除不合适的文字。
  5. 查看文件行号、原文及修改结果报告。

开始使用

将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。

查看 MCP 接入说明

技术信息

分类
编程
适用工具
Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
使用难度
进阶
版本
main
最近更新
2026-11-03
文件数
3
安装包大小
自动生成 ZIP
安全检查
基础检查通过

Check that added comments, docstrings, and changelog entries document the code rather than narrate the change that produced it

使用前准备

  • 能够访问待审查的 Git 仓库及周边代码。
  • 仓库 AGENTS.md 中需提供“Writing for Future Readers”写作规范。
  • 使用默认分支或路径范围时,仓库需有可用于比较的 main 分支。

同类 Skill