pi-comment-checker
通过检测并阻止不必要的注释，强制代码自文档化。
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：pi-comment-checker。 它的用途是：通过检测并阻止不必要的注释，强制代码自文档化。 完整的 Skill 内容见：https://321skill.com/skills/pi-comment-checker/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“检查一下这段函数里的注释是否必要。” 它会调用 pi-comment-checker 的分析能力，扫描你提供的代码块，高亮显示那些冗余或低价值的注释（例如 `// 增加计数器` 这样的注释），并建议你将 `count++` 这样的操作封装成 `incrementCounter()` 这样的函数，从而实现代码自解释。
介绍
在代码开发中，过时、冗余或解释“是什么”而非“为什么”的注释不仅无助于理解，反而可能成为代码异味和误导的来源。pi-comment-checker 这款 Pi 编辑器扩展，旨在通过静态分析自动检测并阻止开发者添加此类不必要的注释，从而引导开发者编写更清晰、更具表达力的自文档化代码。
使用时，开发者只需在支持 Pi 的编辑器中安装此扩展。在编写代码时，当尝试添加诸如 // 循环开始、// 设置变量 等描述代码字面行为的注释时，扩展会实时分析并可能阻止其提交，并给出改进建议，例如建议将变量名改为更具描述性，或将复杂逻辑提取为命名清晰的函数。
它非常适合追求代码整洁、希望团队代码风格统一、并致力于减少技术债务的开发团队和个人。对于初学者，它也是一个很好的教学工具，能帮助其建立“代码即文档”的良好习惯。
使用建议是将其作为代码审查的辅助工具，而非绝对规则。对于解释复杂业务逻辑、算法原理或临时性 hack 的注释，应予以保留。团队引入时建议先作为警告而非错误，待成员适应后再逐步严格。
核心特点
与一般代码格式化或 linting 工具不同，它直接聚焦于“注释”这一具体问题，并采取主动“阻止”而非“标记”的策略，强制开发者即时重构代码而非依赖事后修正。它不检查注释格式，而是判断注释内容的必要性和价值。
注意事项
不适合需要大量解释性注释（如复杂算法、晦涩的第三方库集成或关键业务决策）的项目初期或原型阶段。
常见问题
它会删除我已有的注释吗？
不会，它主要阻止新添加的不必要注释，不主动删除现有代码。
如何区分必要和不必要的注释？
扩展基于启发式规则，通常描述“是什么”（如变量赋值、循环）的会被标记，解释“为什么”或“怎么做”的复杂逻辑则可能通过。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/pi-comment-checker/raw/index.md 读取 pi-comment-checker 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/pi-comment-checker/raw/index.md（查看排版版本）