mcpField
C
cmd-clean-code

cmd-clean-code

github.com/olshansk开发935 次安装1 天前更新
代码仓库

关于 cmd-clean-code

cmd-clean-code 是一项用于整理代码可读性的技能,面向需要清理完整文件、函数或片段的开发者。它要求保留标识符和原有逻辑,并以代码块形式返回整理后的内容。

主要功能

  1. 01降低代码阅读的认知负担
  2. 02保留业务逻辑与标识符
  3. 03调整空白与代码结构
  4. 04将段落式注释改为项目符号
  5. 05保留链接、标记与引用

适用场景

  1. 01整理函数或代码片段以提高可读性
  2. 02统一注释与列表的排版
  3. 03清理代码而不改变功能

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/olshansk/agent-skills --skill cmd-clean-code

安装后在 Claude Code 中输入/cmd-clean-code确认已加载。

详细介绍

整洁代码

使用这些规则提升代码可读性,除非明确要求,否则不要改变功能。

核心原则

  • 减轻人类读者和 Agent 的认知负担。
  • 在适用时采用符合惯例的最佳实践。
  • 除非另有要求,否则保留所有业务逻辑。
  • 尽可能用项目符号明确注释和结构。

接受的输入

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

响应要求

  • 将清理后的代码放在三个反引号括起的代码块中返回。
  • 保留所有标识符(字段、参数、类、方法等)。
  • 适当增加空白行,提升可读性。
  • 可行时,将段落式注释改为项目符号列表。
  • 除非收到要求,否则不要删除或更改原始内容。
  • 信息适合列举时,优先使用项目符号列表。

团队特定边缘情况

  • 保持 TODO_???(???) 标签不变。
  • 保留 IMPORTANT、DEV_NOTE 等提示标记。
  • 保留对 GitHub Issue/PR 的引用(例如“As of #XX ...”)。
  • 保留所有链接和外部引用。
  • 保留 CRITICAL、NB、DEV_NOTE、NOTE 等标记;只整理其后的文本。
处理长片段
  • 对于分组代码(约 5 行)后接空行的情况,在代码块上方添加简短注释。
  • 保留现有注释层级,只改善可读性。

细节与编辑

  • 不要创建只有一项的列表,应改用普通文本。
  • 编辑时绝不删除现有链接。

评论

支持 Markdown