1.2 KiB
1.2 KiB
命名规范
权威合同:
docs/系统架构/新版设计/项目目录与文件职责.md(命名与职责节);机械门禁:make 检查(索引一致性)。
- 中文优先:自有业务目录、文件、模块、类、函数与测试名使用中文;技术约定名称(
pyproject.toml、uv.lock、Makefile、conftest.py、node_modules等)保留英文。 - 展示名与稳定身份分离:对外展示用中文名;稳定身份(case_id、类型 ID、字段 ID、事件类型)用既定英文/十六进制形式,不为改名破坏身份。
- 模块文件三件套:业务模块公开面 =
接口.py;内部 =模型.py+存储.py;不新增平行命名。 - 测试符号:
test_<行为名>__<case6>;参数行保留稳定行 ID。 - 工具脚本:
工具/<动词+对象>.py;登记文件与生成物同名配对(如资源登记.json→src/muse/资源/)。 - 一个概念一个名:术语见
.agent/规范/术语.md;不为风格引入第二名称。 - React 识别前缀:组件使用
Ui加中文业务名,Hook 使用useMuse加中文业务名,保留框架和静态检查所需的英文识别前缀;其余自有业务名仍使用中文。