注释解析优化
This commit is contained in:
@@ -18,7 +18,7 @@ Push 触发 CI 后,按变更类的后缀(`Dto` / `Vo` / `Entity` / `Model`
|
||||
|
||||
## 布局约定
|
||||
|
||||
1. **# 【类变更通知】** — 头部 4 项,每项一行 `>**标签: 值**`(加粗,冒号后两空格);变更对象括号内展示类中文说明(@Schema / Javadoc),无说明则仅类名
|
||||
1. **# 【类变更通知】** — 头部 4 项,每项一行 `>**标签: 值**`(加粗,冒号后两空格);变更对象括号内展示类中文说明(@Schema / @ApiModel / Javadoc),无说明则仅类名
|
||||
2. **## 【对象变更细节】** — 统计行 + 每条变更单行(标签/说明/类型合并)
|
||||
3. **## 【影响范围】** — 各 ### 小节内,每项一行引用
|
||||
|
||||
@@ -55,4 +55,11 @@ Dto/Vo 均固定展示 request、response 两栏;无匹配接口时显示「
|
||||
|
||||
## 实现
|
||||
|
||||
`WeComNotifier.buildMarkdown()` · 消息类型 `markdown` · 路径取自 `ClassChangeReport.sourceFile`
|
||||
| 组件 | 职责 |
|
||||
|------|------|
|
||||
| `ClassDeclParser.extractClassDescription()` | 类级中文说明(Dto / Vo / Entity / Model 通用) |
|
||||
| `ClassFieldParser.extractFieldLabel()` | 字段中文说明(四类通用) |
|
||||
| `ClassChangeAnalyzer` | 编排 diff 并写入 `ClassChangeReport` |
|
||||
| `WeComNotifier.buildMarkdown()` | 渲染企微 `markdown` 通知 |
|
||||
|
||||
路径取自 `ClassChangeReport.sourceFile`。
|
||||
|
||||
@@ -103,4 +103,5 @@
|
||||
| 占位符 | 来源 |
|
||||
|--------|------|
|
||||
| 路径 | Git 相对路径,`ClassChangeReport.sourceFile` |
|
||||
| 说明 | `@Schema` / 注释 |
|
||||
| 类说明 | `@Schema` / `@ApiModel` / 类 Javadoc |
|
||||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc(见 [field-description.md](field-description.md)) |
|
||||
|
||||
@@ -47,3 +47,13 @@
|
||||
> <font color="warning">[类名变更]</font> <font color="comment">TrainingPositionEntity</font> → <font color="info">TrainingPositionNewEntity</font>
|
||||
> <font color="comment">字段无变化</font>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 占位符
|
||||
|
||||
| 占位符 | 来源 |
|
||||
|--------|------|
|
||||
| 路径 | Git 相对路径,`ClassChangeReport.sourceFile` |
|
||||
| 类说明 | `@Schema` / `@ApiModel` / 类 Javadoc |
|
||||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc(见 [field-description.md](field-description.md)) |
|
||||
|
||||
@@ -1,16 +1,19 @@
|
||||
# 字段说明规则
|
||||
|
||||
适用于 **Dto / Vo / Entity / Model** 四类模型类的变更通知。
|
||||
字段变更采用 **引用块 + 单行合并 + font 颜色**,遵循企微 `markdown` v1(不支持列表)。
|
||||
|
||||
## 说明提取优先级
|
||||
|
||||
| 优先级 | 来源 |
|
||||
|:------:|------|
|
||||
| 1 | `@Schema(description = "...")` |
|
||||
| 2 | `@ApiModelProperty` |
|
||||
| 1 | `@Schema(description = "...")` / `@Schema(title = "...")` |
|
||||
| 2 | `@ApiModelProperty(value = "...")` / `@ApiModelProperty(notes = "...")` |
|
||||
| 3 | `/** ... */` 字段注释 |
|
||||
| 4 | 空串 |
|
||||
|
||||
类级说明优先级:`@Schema(description/title)` → `@ApiModel(description/value)` → 类 Javadoc。
|
||||
|
||||
## 字段变更行格式
|
||||
|
||||
每条变更占**一行**,标签、说明、类型横向排列,冒号后两空格:
|
||||
|
||||
@@ -47,3 +47,13 @@
|
||||
> <font color="warning">[类名变更]</font> <font color="comment">AttendanceRuleModel</font> → <font color="info">AttendanceRuleNewModel</font>
|
||||
> <font color="comment">字段无变化</font>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 占位符
|
||||
|
||||
| 占位符 | 来源 |
|
||||
|--------|------|
|
||||
| 路径 | Git 相对路径,`ClassChangeReport.sourceFile` |
|
||||
| 类说明 | `@Schema` / `@ApiModel` / 类 Javadoc |
|
||||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc(见 [field-description.md](field-description.md)) |
|
||||
|
||||
@@ -61,3 +61,13 @@
|
||||
### 类转换影响
|
||||
> <font color="comment">未开启检测</font>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 占位符
|
||||
|
||||
| 占位符 | 来源 |
|
||||
|--------|------|
|
||||
| 路径 | Git 相对路径,`ClassChangeReport.sourceFile` |
|
||||
| 类说明 | `@Schema` / `@ApiModel` / 类 Javadoc |
|
||||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc(见 [field-description.md](field-description.md)) |
|
||||
|
||||
Reference in New Issue
Block a user