75 lines
2.3 KiB
Markdown
75 lines
2.3 KiB
Markdown
# Vo 类变更通知模版
|
||
|
||
**识别规则**：类名以 `Vo` 或 `VO` 结尾。
|
||
**影响范围**：request + response + 类转换（无匹配时对应栏显示「无」）。
|
||
**嵌套标识**：规则同 Dto——仅嵌套时标注 `（嵌套对象）`，嵌套且直接作接口根类型时追加 `（顶层对象）`。
|
||
|
||
---
|
||
|
||
## 完整示例（字段修改）
|
||
|
||
```
|
||
# 【类变更通知】
|
||
|
||
> **变更对象: <font color="info">AttendanceDetailVo</font>（<font color="comment">考勤详情</font>）**
|
||
> **修改人: <font color="comment">张三</font>**
|
||
> **时间: <font color="comment">2026-06-07 14:30:00</font>**
|
||
> **路径: <font color="comment">jnpf-ftb/jnpf-ftb-entity/src/main/java/jnpf/model/attendance/vo/AttendanceDetailVo.java</font>**
|
||
> **分支: <font color="comment">code/code_change_detection_v1.0</font>**
|
||
|
||
## 【对象变更细节】
|
||
|
||
> **共 <font color="warning">2</font> 项变更**
|
||
|
||
> <font color="info">[新增]</font> `overtimeHours` 说明: <font color="comment">加班时长</font>
|
||
|
||
> <font color="warning">[修改]</font> `status` 说明: <font color="comment">考勤状态</font> 类型: <font color="warning">Integer</font> → <font color="info">String</font>
|
||
|
||
## 【影响范围】
|
||
|
||
### 影响 response 接口
|
||
> <font color="info">GET</font> `/api/attendance/detail`
|
||
|
||
### 类转换影响
|
||
> Entity: <font color="info">AttendanceDetailEntity</font>
|
||
```
|
||
|
||
---
|
||
|
||
## 示例（类删除）
|
||
|
||
```
|
||
## 【对象变更细节】
|
||
|
||
> <font color="warning">[已删除]</font> <font color="comment">该类文件已被移除</font>
|
||
```
|
||
|
||
---
|
||
|
||
## 示例（仅类名变更）
|
||
|
||
```
|
||
## 【对象变更细节】
|
||
|
||
> <font color="warning">[类名变更]</font> <font color="comment">AttendanceDetailVo</font> → <font color="info">AttendanceDetailNewVo</font>
|
||
> <font color="comment">字段无变化</font>
|
||
|
||
## 【影响范围】
|
||
|
||
### 影响 response 接口
|
||
> <font color="info">GET</font> `/api/attendance/detail`
|
||
|
||
### 类转换影响
|
||
> <font color="comment">未开启检测</font>
|
||
```
|
||
|
||
---
|
||
|
||
## 占位符
|
||
|
||
| 占位符 | 来源 |
|
||
|--------|------|
|
||
| 路径 | Git 相对路径，`ClassChangeReport.sourceFile` |
|
||
| 类说明 | `@Schema` / `@ApiModel` / 类 Javadoc |
|
||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc（见 [field-description.md](field-description.md)） |
|