注释解析优化
This commit is contained in:
@@ -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。
|
||||
|
||||
## 字段变更行格式
|
||||
|
||||
每条变更占**一行**,标签、说明、类型横向排列,冒号后两空格:
|
||||
|
||||
Reference in New Issue
Block a user