33 lines
613 B
Markdown
33 lines
613 B
Markdown
# 模块文档模板
|
||
|
||
> 复制此文件，重命名为 {module}.md，按实际情况填写
|
||
|
||
## 模块名称
|
||
{模块中文名} / {模块英文名}
|
||
|
||
## 功能概述
|
||
> 一句话说明该模块的职责
|
||
|
||
## 核心实体
|
||
| 实体 | 表/集合 | 说明 |
|
||
|------|--------|------|
|
||
| XxxEntity | t_xxx | ... |
|
||
|
||
## 主要功能点
|
||
- [ ] 功能1
|
||
- [ ] 功能2
|
||
|
||
## 关键业务逻辑
|
||
> 描述复杂逻辑、计算规则、状态流转等
|
||
|
||
## 对外接口（供其他模块调用）
|
||
```java
|
||
// 接口签名 + 说明
|
||
```
|
||
|
||
## 依赖的其他模块
|
||
- 依赖 xxx 模块的 xxx 功能
|
||
|
||
## 已知问题 / 注意事项
|
||
- 注意点1
|