26 lines
997 B
YAML
26 lines
997 B
YAML
- id: require-query-method-prefix
|
|
severity: warning
|
|
description: Service 层查询方法必须以 query/find/get 开头
|
|
message: 查询方法命名不符合团队约定，请以 query/find/get 开头
|
|
languages: [java]
|
|
- id: require-dto-suffix
|
|
severity: warning
|
|
description: 跨服务传输对象类名必须以 DTO 结尾
|
|
message: 传输对象类名请以 DTO 结尾
|
|
languages: [java]
|
|
- id: require-result-wrapper
|
|
severity: warning
|
|
description: Controller 方法返回值必须用 Result 包装，禁止裸返回
|
|
message: Controller 返回值请统一用 Result 包装
|
|
languages: [java]
|
|
- id: require-author-tag
|
|
severity: info
|
|
description: 类的 Javadoc 必须包含 @author 标注，便于代码归属追溯
|
|
message: 类注释请补充 @author 标注
|
|
languages: [java]
|
|
- id: require-chinese-log-message
|
|
severity: info
|
|
description: Service 层日志消息必须使用中文，便于团队统一排查
|
|
message: 日志消息请使用中文
|
|
languages: [java]
|