1
2026-06-08 77eb070046dfac05931f6ddd9cbf681cf09577f2
common/dev-doc/编码规范.md
@@ -6,6 +6,8 @@
引用文件:../../管理系统说明.md;../../全局规范.md;开发环境创建指南.md;开发审计规范.md;编码方案范本.md;AI管理体系建议.md;旧项目开发规范已去项目化抽象。  
记录方式:全局编码规范文档;编码流程、方案要求、测试验收或问题修复口径变化时更新。
统一依赖:本规范必须同时遵守 `../../全局规范.md` 和 `../project-doc/项目规范.md`;项目本地编码规范可补充流程,但不得违反全局规范、全局项目规范和本体系硬约束。
## 1. 目标
本规范用于约束 AI 或人工在项目中编写、修改、验收代码的全过程。
@@ -40,7 +42,8 @@
1. 代码放在 `dev/<target>-dev/`。
2. 测试放在 `dev/<target>-dev/test/`。
3. 目标相关代码文档、测试说明和重型编码方案附件放在 `dev-doc/<target>-doc/`。
4. 开发事项总纲、计划、执行日志、审计报告和问题记录统一放在 `dev-doc/` 根级账本,不在目标目录复制第二套。
4. 开发事项总纲、计划、执行日志和问题记录默认放在 `dev-doc/` 根级账本,不在目标目录复制第二套。
5. 审计报告入口按目标体系分账:需求开发、项目工具开发等独立开发事项写 `dev-doc/开发审计报告.md`;实验开发写 `exp-doc/实验审计报告.md`;案例分析开发写 `ana-doc/案例审计报告.md`。
常见映射:
@@ -166,6 +169,8 @@
这类任务通常不需要先写需求文档,也不需要写代码编写方案。
这类任务完成后通常不强制审核员审核,但必须自测并留下运行方式、输出位置和自测结果。如果代码开始影响核心流程、正式产物、长期接口或被其他事项复用,应升级到有需求文档的轻量实现或重型实现。
需求体系正式交付到开发的事项,默认不适用“无需求文档的轻量实现”。如果需求侧只给了口头要求或草案,应先回到需求流程形成可审计需求,再进入开发。
执行流程:
@@ -205,7 +210,8 @@
4. 写完后先做基础自测,例如语法、导入、最小样本、关键输出。
5. 自检:逐条对比需求文档和代码实现,确认是否有字段缺失、口径偏差、流程绕过、产物不一致。
6. 修掉自检发现的问题。
7. 输出验收结论,说明跑了什么测试、结果是什么、还有什么限制。
7. 交给审核员做轻量代码审核,重点检查需求-代码一致性、自测结果、关键输出、是否越权写正式产物、是否存在明显数据或流程风险。
8. 审核通过后输出验收结论,说明跑了什么测试、结果是什么、还有什么限制。
最低交付:
@@ -213,7 +219,8 @@
2. 对应需求文档。
3. 自测命令和结果。
4. 需求-代码自检结论。
5. 未解决问题或限制。
5. 审核员轻量审核结论。
6. 未解决问题或限制。
### 5.3 有需求文档的重型实现