开发编码技能集

快速入门

本技能集涵盖开发编码的全流程规范，根据任务类型选择对应规范：

任务类型	参考文档
编写代码	core/编码开发.md
添加注释	core/代码注释.md
定位BUG	core/BUG定位修复.md
新增功能	core/新增功能.md
撰写方案	core/技术方案.md

核心开发原则

1. 开闭原则：对扩展开放，对修改关闭
2. 职责单一：每个函数/类只做一件事
3. 命名规范：见名知意，专业规范
4. 注释完备：30%注释率，重要步骤必注
5. 先验证后修复：BUG定位必须复现再修复
6. 高内聚低耦合：模块独立，便于复用

任务处理流程

【新增功能】

1. 理解需求 → 2. 设计实现方案 → 3. 撰写技术方案 → 4. 编码实现 → 5. 单元测试 → 6. 自检清单

【BUG修复】

1. 复现问题 → 2. 定位根因 → 3. 验证修复 → 4. 回归测试 → 5. 清理调试代码

详细规范文档

编码开发规范

文件：core/编码开发.md

核心内容：

• 原则规范：开闭原则、职责单一、模块解耦
• 规范编码：命名规范、函数设计、步骤封装
• 细节处理：print输出、异常处理
• 编码自检清单：原则/命名/可读性/功能检查
• Git提交前检查：提交信息格式、提交范围

何时阅读：开始编码前必读

代码注释规范

文件：core/代码注释.md

核心内容：

• 文件头注释规范
• 常量/枚举注释规范
• 接口/抽象类注释规范
• 类注释规范
• 方法函数注释规范

何时阅读：编写注释前必读

BUG定位修复规范

文件：core/BUG定位修复.md

核心内容：

• 先验证后修复原则
• 常见Bug类型分类（6大类）
• 定位问题常用手段（5种方法）
• 修复后必做清单

何时阅读：遇到BUG时必读

新增功能规范

文件：core/新增功能.md

核心内容：

• 需求理解检查清单
• 设计自检要点
• 实施前方案评估
• 实施后检查

何时阅读：新增功能前必读

技术方案规范

文件：core/技术方案.md

核心内容：

• 文档内容结构
• 图表绘制要求
• 文档撰写检查清单
• 评审要点

何时阅读：撰写技术方案前必读

输出格式要求

代码输出

• 注释率不低于30%
• 关键步骤有空行+行首注释
• 难点代码有同行末尾注释
• 包含单元测试

文档输出

• 内容规范、简要、准确
• 语言表述清晰专业
• 章节逻辑清晰
• 便于后续编码实现

自检清单汇总

编码完成后必查

• 是否遵循开闭原则
• 是否遵循职责单一原则
• 模块是否独立解耦
• 类名、函数名、变量名是否专业规范
• 注释率是否达到30%
• 单元测试是否覆盖核心功能

提交前必查

• 运行lint/typecheck工具
• 运行单元测试
• 清理调试代码
• 未提交敏感信息

注意事项

1. 严格遵循规范：编码前务必阅读对应规范文档
2. 先验证后修复：BUG修复必须复现问题再修改
3. 最小改动原则：新增功能只修改必要代码，遵循开闭原则
4. 自检必做：完成后必须按清单自检
5. 及时清理：调试代码和日志在完成后及时清理