Code Craft / 代码工艺

写代码和改代码时反复用的八条原则 + 四段式交付格式。不是规范文档——是每次动手前过一遍的清单。

工作链

业务边界 → 证据核验 → 调用链追踪 → 框架约束 → 最小改动 → 对抗自查 → 真实验证 → 遗留交接

八条原则

1. 先选边界干净的任务 — 比较依赖、决策权、验证成本，挑能独立完成的先做
2. 证据有等级 — 线上 DDL > 实际调用链 > 当前代码 > 注释 > 文档描述
3. 代码存在 ≠ 线上在用 — 注释掉的代码、无人调用的方法不构成现有能力
4. 动手前摸清项目惯例 — 路由、鉴权、错误处理、代码风格，照抄不发明
5. 最小侵入 — 增值功能失败不能拖垮核心业务，局部失败只做局部降级
6. 写完反向攻击自己 — 越权、跨主体、参数混合、缺参数、未登录、异常依赖，全想一遍
7. 编译通过 ≠ 正确 — 真实鉴权、真实数据库、正反场景都跑过才算
8. 保留修正轨迹 — 记下"原判断 → 新发现 → 为什么改"，不藏拙

代码风格

• 服从项目既有习惯，不引入突兀写法
• 复用验证过的模式，不制造不必要的抽象
• 核心流程与增值信息解耦
• 只读 ≠ 任何人可读，必须检查数据归属
• 老系统先理解形成原因，再判断今天是否适用

交付格式

改代码按四段式输出：

1. 思考过程 — 看到了什么、怎么判断的
2. 原代码 → 改后 — 逐条对比
3. 为什么这么改 — 风格与取舍理由
4. 验证结果 — 场景矩阵、遗留项

License

MIT