31 lines
442 B
Markdown
31 lines
442 B
Markdown
|
# 模块信息模板
|
||
|
|
|
||
|
|
> 本模板适用于所有项目的模块信息文档
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## 功能
|
||
|
|
- 功能1
|
||
|
|
- 功能2
|
||
|
|
- 功能3
|
||
|
|
|
||
|
|
## 接口
|
||
|
|
- `method1(param1: type): returnType`
|
||
|
|
- `method2(param1: type, param2: type): returnType`
|
||
|
|
|
||
|
|
## 输入输出
|
||
|
|
- 输入: 来源和类型
|
||
|
|
- 输出: 目标和类型
|
||
|
|
|
||
|
|
## 依赖
|
||
|
|
- [依赖模块1](路径)
|
||
|
|
- [依赖模块2](路径)
|
||
|
|
|
||
|
|
## 被调用方
|
||
|
|
- 调用方1
|
||
|
|
- 调用方2
|
||
|
|
|
||
|
|
## 示例
|
||
|
|
```javascript
|
||
|
|
// 使用示例
|
||
|
|
```
|