22 lines
1.0 KiB
Markdown
22 lines
1.0 KiB
Markdown
# 模块命名规范
|
|
|
|
## 适用范围
|
|
|
|
- 当任务涉及新增/修改业务模块命名、中英文对照、目录命名、表前缀、字典编码时，先读本文件。
|
|
|
|
## 强制规则
|
|
|
|
- 模块中文名与英文名的映射统一登记在本文件；禁止同一业务出现多个英文命名。
|
|
- 同一业务模块在 `router`、`api`、`service`、`model`、表名、字典编码、接口路径中必须使用同一英文词根；禁止混用近义词或复数变体。
|
|
- 模块英文名统一使用小写登记值；需要拼接时，按目标位置使用既有规范展开，不单独发明新缩写。
|
|
- 新增模块词汇时，必须先更新本文件，再进入代码实现。
|
|
- 已登记模块命名默认视为稳定约束；如需改名，必须先更新本文件并评估受影响目录、表、接口、字典和文档。
|
|
|
|
## 模块词汇
|
|
|
|
| 中文 | 英文 | 说明 |
|
|
|:---|:---|:---|
|
|
| 通用 | common | 跨业务复用的通用值域与模型 |
|
|
| 书籍 | book | 书籍与章节相关业务模块 |
|
|
| 设备 | device | 设备管理模块 |
|