API注释规范

API注释规范

【免费下载链接】cool-request IDEA中快速调试接口、定时器插件 项目地址: https://gitcode.com/gh_mirrors/co/cool-request

继承使用原则

1. 所有接口方法必须添加完整@Operation注释
2. 实现类重写方法时：
   • 如无特殊说明，使用@inheritDoc继承父注释
   • 如有补充说明，保留核心字段，扩展description

示例

// 推荐写法
@Override
@Operation(
    summary = "获取用户信息", // 继承自接口
    description = "扩展：支持加密ID查询 | " + ApiDocConstants.COMMON_DESC // 补充说明
)
public ResponseEntity<UserDTO> getUser(String id) { ... }

【免费下载链接】cool-request IDEA中快速调试接口、定时器插件 项目地址: https://gitcode.com/gh_mirrors/co/cool-request