edit | blame | history | raw

编码规范

创建人员:Codex
文件职责:作为 Project D 开发体系根级编码规范入口,引用 common 开发编码规范,并记录本项目开发体系的稳定补充。
管理规范/模板:../../common/dev-doc/编码规范.md;../项目配置清单.md。
引用文件:../项目配置清单.md;../项目事项总纲.md;../项目事项计划.md;../项目执行日志.md;../项目事项审计报告.md。
记录方式:项目级开发入口规范;默认只记录项目级稳定补充,不记录目标开发工作区细节。

1. 基本口径

Project D 所有开发事项必须遵守 ../../common/dev-doc/编码规范.md

本文件是项目级开发体系入口,不替代目标开发工作区规范。后续创建具体目标开发工作区时,按 ../../common/dev-doc/开发环境创建指南.mddev-doc/<target>-doc/ 下创建目标级 编码规范.md

2. 本地补充

当前暂无 Project D 特化编码规则。

如后续新增本地补充,只能补充 common 硬约束,不能削弱 common 规范。

3. 核心开发文档作用

文档 作用
目录导读.md 说明 Project D 开发目录结构、代码入口、测试入口、当前事项和审计入口
编码规范.md 记录 Project D 本地编码规范和 common 规范引用
开发审计规范.md 记录 Project D 本地开发审计规范和 common 审计规范引用
开发事项总纲.md 记录开发事项背景、目标、边界、状态和结论
开发事项计划.md 记录开发计划、步骤、输入输出、验收方式和审计入口
开发方案/ 重型开发时按事项创建具体编码方案文件;轻量开发不创建
开发执行日志.md 记录编码、测试、自检、中间结果、异常和偏离
开发审计报告.md 记录方案审核、实现审核、测试验收和复审结论
开发问题记录.md 记录非审计来源开发问题;审计问题只做跨轮索引