SuperAPI AI 工具集

cmd-clean-code

编程与开发

查看项目

更新于 10-16 02:37

技能介绍

用途:在不改变功能的前提下提升代码可读性,除非用户明确要求修改功能。核心原则包括降低人类读者与智能体的认知负担、在合适处应用惯用最佳实践、保留全部业务逻辑、尽量用要点澄清注释与结构。

接受的输入:完整源文件(如 .proto、.go、.py、.md 等)、部分注释(包头部、方法文档、行内说明)、完整或部分函数、任意代码片段,以及以上内容的混合。

响应要求:清理后的代码用三重反引号包裹返回;保留所有标识符(字段、参数、类、方法等);为可读性添加策略性空白;在可行时把段落式注释转为要点;除非被要求,不删除或更改原始内容;信息呈列表状时优先使用项目符号列表。

团队特定边界情况:保持 TODO_???(???) 标签不变;保留 IMPORTANT、DEV_NOTE 等提示标记;保留对 GitHub issue/PR 的引用(如 “As of #XX ...”);保留每个链接与外部引用;保留 CRITICAL、NB、DEV_NOTE、NOTE 等标记,仅清理其后的文本。

处理长片段:对于约 5 行成组代码后跟空行的情况,在代码块顶部添加简短注释;保持现有注释层级,仅增强可读性。

细节与编辑:不要创建只含一个条目的列表,应写成纯文本;编辑时绝不删除现有链接。

限制:资料未提供安装命令、平台、收费或价格信息;该技能聚焦可读性整理,不负责功能变更或重构。