Files
MDHelper/docs/coding_conventions.md
T
2026-05-25 17:12:00 +08:00

9 lines
667 B
Markdown

# M3Frame 编码与文档规范
1. 文档与注释以中文为主,允许保留必要的英文术语,例如 CUDA、VTU、Newmark、Mortar。
2. 所有源码、XML、JSON、YAML、Markdown 文件统一使用 UTF-8。
3. 公共 API 注释应说明职责、输入输出和边界条件,避免堆叠实现细节。
4. 配置文件统一先读入 `io::ConfigDocument`,业务模块不得直接依赖 XML/JSON/YAML 语法细节。
5. 新示例路径采用 `examples/<domain>/<case>`,新测试路径采用 `tests/<level>/<module>`。
6. 新输出路径采用 `outputs/<case_name>/<category>`,并保留 run manifest 记录输入、输出、后端和时间信息。