关于 code-comments-improve
此技能会检查指定文件或近期修改文件中的代码注释，在需要时补充背景，并修订含糊、冗余或过时的注释。重点解释决策依据和约束，而非复述代码。
主要功能
- 01分析代码结构和现有注释
- 02为复杂逻辑和边缘情况补充注释
- 03修订含糊或过时的注释
- 04删除冗余注释
- 05注释聚焦决策依据与约束
适用场景
- 01说明采用非直观算法的原因
- 02记录假设和边缘情况处理
- 03实现变更后更新注释
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/code-comments-improve确认已加载。
详细介绍
改进指定文件（如果未提供指定文件，则改进最近处理过的文件）中的代码注释：
-
分析代码结构和现有注释
- 阅读指定文件或找出最近修改的文件
- 识别函数、类和复杂逻辑块
- 评估现有注释是否清晰且有用
-
在适当位置添加内联注释：
- 仅看代码本身不易理解的复杂业务逻辑
- 不明显的算法选择或优化
- 重要假设或限制
- 边缘情况及其处理方式
- 与外部系统的集成点
-
改进现有注释：
- 简化冗长或充斥技术术语的注释
- 删除只是复述代码的多余注释
- 修正与当前实现不符的过时注释
- 在适当时将说明「做什么」的注释改为说明「为什么」的注释
-
关注原因，而非做法：
- 说明业务原因和决策依据
- 记录为何选择此方案而非其他方案
- 澄清不明显的要求或限制
- 避免为命名清晰、显而易见的代码添加注释
-
注释指南：
- 注释简洁、重点明确
- 使用清晰、简单的语言
- 确保注释能补充代码未表达的信息
- 将注释放在相关代码附近
- 与项目的注释风格保持一致
输出：展示改进后的代码，并说明添加或修改每条注释的原因。
评论
支持 Markdown