1.2 KiB
1.2 KiB
字段说明规则
字段变更采用 引用块 + 换行 + font 颜色,遵循企微 markdown v1(不支持列表)。
说明提取优先级
| 优先级 | 来源 |
|---|---|
| 1 | @Schema(description = "...") |
| 2 | @ApiModelProperty |
| 3 | /** ... */ 字段注释 |
| 4 | 空串 |
字段变更行格式
> <font color="comment">共 4 项字段变更</font>
> <font color="warning">[修改]</font> `taskId`
> 说明:<font color="comment">流程主键</font>
> 类型:<font color="warning">Integer</font> → <font color="info">String</font>
> <font color="info">[新增]</font> `storeId`
> 说明:<font color="comment">门店ID</font>
| 操作 | 标签 | 类型行 |
|---|---|---|
| 新增 | info [新增] |
无 |
| 删除 | warning [删除] |
无 |
| 修改 | warning [修改] |
仅类型变化时出现 |
- 字段间用空行分隔,便于对照
- 说明为空时显示
<font color="comment">(无说明)</font> - 不要在
<font>内嵌**bold**
接口行格式
> <font color="info">POST</font> `/apply/clockIn`
实现
ClassFieldParser.extractFieldLabel()FieldDiffEngine— 仅类型变化产生[修改]WeComNotifier.formatFieldChange()