style: 统一请求参数、响应参数注释

This commit is contained in:
2025-04-17 21:57:09 +08:00
parent 1c85b43931
commit bf3e1590fa
9 changed files with 29 additions and 26 deletions

View File

@@ -34,7 +34,7 @@ public interface AuthService {
/**
* 登录
*
* @param req 登录请求参数
* @param req 请求参数
* @param request 请求对象
* @return 登录响应参数
*/

View File

@@ -98,15 +98,17 @@ public interface FileService extends BaseService<FileResp, FileResp, FileQuery,
/**
* 检查文件是否存在
* @param fileHash
* @return
*
* @param fileHash 文件 Hash
* @return 响应参数
*/
FileResp check(String fileHash);
/**
* 创建目录
* @param req
* @return
*
* @param req 请求参数
* @return ID
*/
IdResp<Long> createDir(FileReq req);
}

View File

@@ -44,7 +44,7 @@ public interface MessageService {
/**
* 新增
*
* @param req 新增信息
* @param req 请求参数
* @param userIdList 接收人列表
*/
void add(MessageReq req, List<Long> userIdList);

View File

@@ -41,7 +41,7 @@ public interface RoleService extends BaseService<RoleResp, RoleDetailResp, RoleQ
* 修改角色权限
*
* @param id 角色 ID
* @param req 参数
* @param req 请求参数
*/
void updatePermission(Long id, RoleUpdatePermissionReq req);

View File

@@ -58,7 +58,7 @@ public interface UserService extends BaseService<UserResp, UserDetailResp, UserQ
/**
* 导入数据
*
* @param req 导入信息
* @param req 请求参数
* @return 导入结果
*/
UserImportResp importUser(UserImportReq req);
@@ -66,7 +66,7 @@ public interface UserService extends BaseService<UserResp, UserDetailResp, UserQ
/**
* 重置密码
*
* @param req 重置信息
* @param req 请求参数
* @param id ID
*/
void resetPassword(UserPasswordResetReq req, Long id);