general-coding

name	general-coding
description	通用编码规范，当用户编写或修改代码时自动应用。涵盖 SOLID 原则、命名规范、函数设计、注释规范、错误处理和测试原则。

通用编码 Skill

为 AI 编码助手提供统一的编码规范指引，确保生成的代码符合团队标准。

设计原则

在编写任何代码前，检查以下原则：

1. 单一职责: 每个模块/类/函数只做一件事。
2. 开闭原则: 优先通过扩展而非修改来增加功能。
3. 依赖倒置: 依赖抽象而非具体实现。
4. DRY: 消除重复。同一逻辑不出现两次。
5. KISS: 选择最简单的可行方案。不过度设计。
6. YAGNI: 不为"可能将来需要"的功能编码。

命名规范

• 使用意图明确的名称（fetchUserById 而非 get）
• 同一概念保持统一词汇（如全项目统一用 fetch 而非混用 get/retrieve）
• 布尔值使用 is/has/can/should 前缀
• 避免缩写和单字母变量（循环变量除外）

函数设计

• 单个函数不超过 30-50 行
• 参数不超过 3-4 个；超过时封装为对象
• 优先编写纯函数，副作用在函数名中体现
• 使用 early return 减少嵌套

注释

• 解释「为什么」而非「是什么」
• 公共 API 必须有文档注释
• TODO/FIXME 需附带日期和负责人

错误处理

• 不吞没异常（禁止空 catch 块）
• 错误信息包含操作上下文和关键参数
• 区分业务异常和系统异常
• 在下层尽早发现，在上层统一处理

输出要求

编写代码时：

1. 优先使用语言惯用写法（idiomatic code）
2. 处理所有可能的异常路径
3. 考虑边界条件（空值、空列表、极端值）
4. 为主要逻辑附加简要说明