160 lines
2.9 KiB
Markdown
160 lines
2.9 KiB
Markdown
|
|
# 方法逻辑模板
|
|||
|
|
|
|||
|
|
## 元数据
|
|||
|
|
- 需求编号:
|
|||
|
|
- 创建时间:YYYY-MM-DD
|
|||
|
|
- 创建人:
|
|||
|
|
- 状态:进行中/已完成
|
|||
|
|
|
|||
|
|
## 方法概述
|
|||
|
|
- **方法名称**:
|
|||
|
|
- **所属模块**:
|
|||
|
|
- **功能描述**:
|
|||
|
|
- **使用场景**:
|
|||
|
|
|
|||
|
|
## 方法签名
|
|||
|
|
```java
|
|||
|
|
// 方法签名示例
|
|||
|
|
public ReturnType methodName(ParamType param1, ParamType param2) throws ExceptionType {
|
|||
|
|
// 实现
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 参数说明
|
|||
|
|
| 参数名 | 类型 | 必填 | 描述 | 默认值 | 示例值 |
|
|||
|
|
| ------ | ---- | ---- | ---- | ------ | ------ |
|
|||
|
|
| param1 | ParamType | 是 | 参数1描述 | - | value1 |
|
|||
|
|
| param2 | ParamType | 否 | 参数2描述 | defaultValue | value2 |
|
|||
|
|
|
|||
|
|
## 返回值说明
|
|||
|
|
| 类型 | 描述 | 示例值 |
|
|||
|
|
| ---- | ---- | ------ |
|
|||
|
|
| ReturnType | 返回值描述 | returnValue |
|
|||
|
|
|
|||
|
|
## 异常说明
|
|||
|
|
| 异常类型 | 触发条件 | 描述 |
|
|||
|
|
| ------ | ------ | ---- |
|
|||
|
|
| ExceptionType1 | 条件1 | 异常1描述 |
|
|||
|
|
| ExceptionType2 | 条件2 | 异常2描述 |
|
|||
|
|
|
|||
|
|
## 执行流程
|
|||
|
|
|
|||
|
|
### 流程图
|
|||
|
|
```
|
|||
|
|
[方法执行的流程图]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 详细步骤
|
|||
|
|
1. **步骤1**:
|
|||
|
|
2. **步骤2**:
|
|||
|
|
3. **步骤3**:
|
|||
|
|
4. **步骤4**:
|
|||
|
|
5. **步骤5**:
|
|||
|
|
|
|||
|
|
## 逻辑分支
|
|||
|
|
|
|||
|
|
### 分支1:[条件描述]
|
|||
|
|
- **触发条件**:
|
|||
|
|
- **执行逻辑**:
|
|||
|
|
- **预期结果**:
|
|||
|
|
|
|||
|
|
### 分支2:[条件描述]
|
|||
|
|
- **触发条件**:
|
|||
|
|
- **执行逻辑**:
|
|||
|
|
- **预期结果**:
|
|||
|
|
|
|||
|
|
### 分支3:[条件描述]
|
|||
|
|
- **触发条件**:
|
|||
|
|
- **执行逻辑**:
|
|||
|
|
- **预期结果**:
|
|||
|
|
|
|||
|
|
## 边界条件
|
|||
|
|
|
|||
|
|
| 边界条件 | 处理逻辑 | 预期结果 |
|
|||
|
|
| ------ | ------ | ------ |
|
|||
|
|
| 条件1 | 处理逻辑1 | 结果1 |
|
|||
|
|
| 条件2 | 处理逻辑2 | 结果2 |
|
|||
|
|
| 条件3 | 处理逻辑3 | 结果3 |
|
|||
|
|
|
|||
|
|
## 算法设计(可选)
|
|||
|
|
|
|||
|
|
### 算法概述
|
|||
|
|
[算法概述]
|
|||
|
|
|
|||
|
|
### 算法流程
|
|||
|
|
```
|
|||
|
|
[算法流程的可视化表示]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 时间复杂度
|
|||
|
|
[时间复杂度分析]
|
|||
|
|
|
|||
|
|
### 空间复杂度
|
|||
|
|
[空间复杂度分析]
|
|||
|
|
|
|||
|
|
## 代码实现
|
|||
|
|
```java
|
|||
|
|
// 完整的代码实现
|
|||
|
|
public ReturnType methodName(ParamType param1, ParamType param2) throws ExceptionType {
|
|||
|
|
// 实现逻辑
|
|||
|
|
return result;
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 调用关系
|
|||
|
|
|
|||
|
|
### 调用该方法的组件
|
|||
|
|
| 组件名称 | 调用场景 |
|
|||
|
|
| ------ | ------ |
|
|||
|
|
| 组件1 | 场景1 |
|
|||
|
|
| 组件2 | 场景2 |
|
|||
|
|
|
|||
|
|
### 该方法调用的组件
|
|||
|
|
| 组件名称 | 调用目的 |
|
|||
|
|
| ------ | ------ |
|
|||
|
|
| 组件1 | 目的1 |
|
|||
|
|
| 组件2 | 目的2 |
|
|||
|
|
|
|||
|
|
## 测试用例
|
|||
|
|
|
|||
|
|
### 测试用例1:正常情况
|
|||
|
|
- **测试目标**:
|
|||
|
|
- **输入**:
|
|||
|
|
```
|
|||
|
|
param1: value1
|
|||
|
|
param2: value2
|
|||
|
|
```
|
|||
|
|
- **预期输出**:
|
|||
|
|
```
|
|||
|
|
returnValue
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 测试用例2:边界情况
|
|||
|
|
- **测试目标**:
|
|||
|
|
- **输入**:
|
|||
|
|
```
|
|||
|
|
param1: boundaryValue
|
|||
|
|
```
|
|||
|
|
- **预期输出**:
|
|||
|
|
```
|
|||
|
|
expectedResult
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 测试用例3:异常情况
|
|||
|
|
- **测试目标**:
|
|||
|
|
- **输入**:
|
|||
|
|
```
|
|||
|
|
param1: invalidValue
|
|||
|
|
```
|
|||
|
|
- **预期输出**:
|
|||
|
|
```
|
|||
|
|
ExceptionType
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 优化建议
|
|||
|
|
- 优化建议1:
|
|||
|
|
- 优化建议2:
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
- [需求文档](../requirements/YYYY-MM-DD-00X-需求名.md)
|
|||
|
|
- [设计文档](../design/YYYY-MM-DD-00X-设计名.md)
|