关于 code-style
一组用于编写和组织代码的风格规则,面向希望保持代码简洁、易读的开发者。规则涵盖函数与文件拆分、代码排列、注释和抽象的使用。
主要功能
- 01保持函数简短并拆分职责
- 02按职责拆分较长文件
- 03将公开函数放在文件前部
- 04注释说明意外之处及原因
- 05避免过早引入抽象
适用场景
- 01制定团队代码审查标准
- 02整理职责过多的函数
- 03规划较长文件的拆分方式
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ frappe/ skills --skill code-style安装后在 Claude Code 中输入/code-style确认已加载。
详细介绍
代码风格规则
- 保持函数简短。如果一个函数承担多项任务,或需要分成多个部分才易于阅读,就将其拆分。
- 尽可能将文件控制在 300 行以内。按职责拆分,而不是按任意层级拆分。
- 优先使用面向对象代码,而不是分散的函数。
- 将高阶函数和公共函数放在文件顶部;将底层工具函数放在底部。
- 使用简洁明了的英文注释。解释令人意外之处的原因;不要描述显而易见的代码。
- 在出现具体的重复用例之前,不要添加抽象。
评论
支持 Markdown