[app-builder] correct comments style

Author: desAweis

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/common/resp/Response.java

@@ -16,10 +16,10 @@
 import java.io.Serializable;
 
 /**
- * app-base 响应类
- *
- * @since 2024-5-27
+ * 基础应用响应类。
  *
+ * @author 陈潇文
+ * @since 2024-05-27
  */
 @Data
 @NoArgsConstructor
@@ -37,10 +37,11 @@ public class Response<T> implements Serializable {
     private String msg;
 
     /**
-     * 请求成功返回数据
+     * 请求成功返回数据。
      *
-     * @param data 数据
-     * @return 响应
+     * @param data 表示数据的 {@link T}。
+     * @param <T> 表示泛型类型的 {@link T}。
+     * @return 表示响应的 {@link Response}@{code <}{@link T}{@code >}。
      */
     public static <T> Response<T> success(T data) {
         Response<T> response = new Response<>();
@@ -51,10 +52,10 @@ public static <T> Response<T> success(T data) {
     }
 
     /**
-     * 请求成功返回
+     * 请求成功返回。
      *
-     * @param <T> 泛型类数据
-     * @return 响应
+     * @param <T> 表示泛型类型的 {@link T}。
+     * @return 表示响应的 {@link Response}{@code <}{@link T}{@code >}。
      */
     public static <T> Response<T> success() {
         Response<T> response = new Response<>();
@@ -65,11 +66,11 @@ public static <T> Response<T> success() {
     }
 
     /**
-     * 请求成功返回
+     * 请求成功返回。
      *
-     * @param data 响应数据
-     * @param code 响应码
-     * @return 响应
+     * @param data 表示响应数据的 {@link T}。
+     * @param code 表示响应码的 {@link ErrorCode}。
+     * @return 表示响应的 {@link Response}{@code <}{@link T}{@code >}。
      */
     public static <T> Response<T> success(T data, ErrorCode code) {
         Response<T> response = new Response<>();
@@ -80,12 +81,12 @@ public static <T> Response<T> success(T data, ErrorCode code) {
     }
 
     /**
-     * 请求成功返回
+     * 请求成功返回。
      *
-     * @param code 响应码
-     * @return 响应
+     * @param code 表示响应码的 {@link ErrorCode}。
+     * @return 表示响应的 {@link Response}{@code <}{@link T}{@code >}。
      */
-    public static <T >Response<T> success(ErrorCode code) {
+    public static <T> Response<T> success(ErrorCode code) {
         Response<T> response = new Response<>();
         response.setCode(code.getErrorCode());
         response.setMsg(code.getMessage());
@@ -94,10 +95,10 @@ public static <T >Response<T> success(ErrorCode code) {
     }
 
     /**
-     * 请求失败返回
+     * 请求失败返回。
      *
-     * @param code 响应码
-     * @return 响应
+     * @param code 表示响应码的 {@link ErrorCode}。
+     * @return 表示响应的 {@link Response}{@code <}{@link T}{@code >}。
      */
     public static <T> Response<T> err(ErrorCode code) {
         Response<T> response = new Response<>();
@@ -108,10 +109,10 @@ public static <T> Response<T> err(ErrorCode code) {
     }
 
     /**
-     * 请求失败返回
+     * 请求失败返回。
      *
-     * @param <T> 泛型类数据
-     * @return 响应
+     * @param <T> 表示泛型类型的 {@link T}。
+     * @return 表示响应的 {@link Response}{@code <}{@link T}{@code >}。
      */
     public static <T> Response<T> err() {
         Response<T> response = new Response<>();

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/common/resp/ResponseCode.java

@@ -11,10 +11,10 @@
 import lombok.AllArgsConstructor;
 
 /**
- * app-base 错误码
- *
- * @since 2024-5-27
+ * 基础应用错误码。
  *
+ * @author 陈潇文
+ * @since 2024-05-27
  */
 @AllArgsConstructor
 public enum ResponseCode implements ErrorCode {

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/controller/AppBuilderRecommendController.java

@@ -20,7 +20,7 @@
 import java.util.List;
 
 /**
- * 猜你想问获取接口
+ * 猜你想问获取接口。
  *
  * @author 杨海波
  * @since 2024-05-24
@@ -36,10 +36,11 @@ public AppBuilderRecommendController(AppBuilderRecommendService recommendService
     }
 
     /**
-     * 获取猜你想问推荐列表
+     * 获取猜你想问推荐列表。
      *
-     * @param recommendDto 包含上次对话用户提问及模型回答
-     * @return 三个推荐问题列表
+     * @param request 表示 HTTP 请求上下文的 {@link HttpClassicServerRequest}。
+     * @param recommendDto 表示包含上次对话用户提问及模型回答的 {@link AppBuilderRecommendDto}。
+     * @return 表示返回体的 {@link Rsp}{@code <}{@link List}{@code <}{@link String}{@code >>}。
      */
     @PostMapping
     public Rsp<List<String>> queryRecommends(HttpClassicServerRequest request,

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/controller/UserCollectionController.java

@@ -23,10 +23,10 @@
 import java.util.List;
 
 /**
- * 处理用户收藏应用请求
- *
- * @since 2024-5-29
+ * 处理用户收藏应用请求。
  *
+ * @author 陈潇文
+ * @since 2024-05-29
  */
 @Component
 @RequestMapping("/aipp/user")
@@ -38,10 +38,10 @@ public UserCollectionController(UserAppCollectionService userAppCollectionServic
     }
 
     /**
-     * 创建用户应用收藏记录
+     * 创建用户应用收藏记录。
      *
-     * @param userAppCollectionDto 用户应用收藏消息体
-     * @return 收藏记录id
+     * @param userAppCollectionDto 表示用户应用收藏消息体的 {@link UserAppCollectionDto}。
+     * @return 表示返回收藏记录标识的 {@link Response}{@code <}{@link Long}{@code >}。
      */
     @PostMapping("/collection")
     public Response<Long> createUserAppCollection(@RequestBody UserAppCollectionDto userAppCollectionDto) {
@@ -50,10 +50,10 @@ public Response<Long> createUserAppCollection(@RequestBody UserAppCollectionDto
     }
 
     /**
-     * 删除应用收藏记录
+     * 删除应用收藏记录。
      *
-     * @param userAppCollectionDto 应用收藏记录信息
-     * @return 响应
+     * @param userAppCollectionDto 表示应用收藏记录信息。
+     * @return 表示响应的 {@link Response}{@code <}{@link Void}{@code >}。
      */
     @DeleteMapping("/collection")
     public Response<Void> deleteUserCollectionApp(@RequestBody UserAppCollectionDto userAppCollectionDto) {
@@ -63,32 +63,32 @@ public Response<Void> deleteUserCollectionApp(@RequestBody UserAppCollectionDto
     }
 
     /**
-     * 通过用户信息获取应用收藏列表
+     * 通过用户信息获取应用收藏列表。
      *
-     * @param userInfo 用户信息
-     * @return 收藏应用列表
+     * @param userInfo 表示用户信息的 {@link String}。
+     * @return 表示收藏应用列表的 {@link Response}{@code <}{@link List}{@code <}{@link UserAppCollectionPo}{@code >>}。
      */
     @GetMapping("/collection/{userInfo}")
     public Response<List<UserAppCollectionPo>> getCollectionsByUserInfo(@PathVariable("userInfo") String userInfo) {
         return Response.success(this.userAppCollectionService.getCollectionsByUserInfo(userInfo), ResponseCode.OK);
     }
 
     /**
-     * 通过用户信息获取应用收藏列表详细信息
+     * 通过用户信息获取应用收藏列表详细信息。
      *
-     * @param userInfo 用户信息
-     * @return 收藏应用列表详细信息
+     * @param userInfo 表示用户信息的 {@link String}。
+     * @return 表示收藏应用列表详细信息的 {@link Response}{@code <}{@link CollectionAppInfoDto}{@code >}。
      */
     @GetMapping("/collection/app/{userInfo}")
     public Response<CollectionAppInfoDto> getAppCollectionInfoByUserInfo(@PathVariable("userInfo") String userInfo) {
         return Response.success(this.userAppCollectionService.getAppInfoByUserInfo(userInfo), ResponseCode.OK);
     }
 
     /**
-     * 获取应用收藏用户数量
+     * 获取应用收藏用户数量。
      *
-     * @param appId 应用id
-     * @return 用户收藏数量
+     * @param appId 表示应用唯一标识的 {@link String}。
+     * @return 表示用户收藏数量的 {@link Response}{@code <}{@link Integer}{@code >}。
      */
     @GetMapping("/collection/count/{appId}")
     public Response<Integer> getCollectionUserCntByAppId(@PathVariable("appId") String appId) {

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/controller/UserFeedbackController.java

@@ -20,10 +20,10 @@
 import java.util.List;
 
 /**
- * 处理用户Aipp请求
- *
- * @since 2024-5-24
+ * 处理用户反馈请求。
  *
+ * @author 陈潇文
+ * @since 2024-05-24
  */
 @Component
 @RequestMapping("/aipp/user")
@@ -35,20 +35,20 @@ public UserFeedbackController(UserFeedbackService userFeedbackService) {
     }
 
     /**
-     * 创建用户反馈记录
+     * 创建用户反馈记录。
      *
-     * @param userFeedbackDto 用户反馈消息体
+     * @param userFeedbackDto 表示用户反馈消息体的 {@link UserFeedbackDto}。
      */
     @PostMapping("/feedback")
     public void createUserFeedback(@RequestBody UserFeedbackDto userFeedbackDto) {
         this.userFeedbackService.create(userFeedbackDto);
     }
 
     /**
-     * 更新用户反馈信息
+     * 更新用户反馈信息。
      *
-     * @param userFeedbackDto 用户反馈消息体
-     * @param instanceId 对话实例Id
+     * @param instanceId 表示对话实例唯一标识的 {@link String}。
+     * @param userFeedbackDto 表示用户反馈消息体的 {@link UserFeedbackDto}。
      */
     @PatchMapping("/feedback/{instanceId}")
     public void updateUserFeedback(@PathVariable("instanceId") String instanceId,
@@ -57,30 +57,30 @@ public void updateUserFeedback(@PathVariable("instanceId") String instanceId,
     }
 
     /**
-     * 删除用户反馈信息
+     * 删除用户反馈信息。
      *
-     * @param instanceId 对话实例Id
+     * @param instanceId 表示对话实例唯一标识的 {@link String}。
      */
     @DeleteMapping("/feedback/{instanceId}")
     public void deleteByLogId(@PathVariable("instanceId") String instanceId) {
         this.userFeedbackService.deleteByLogId(instanceId);
     }
 
     /**
-     * 获取用户反馈信息列表
+     * 获取用户反馈信息列表。
      *
-     * @return 用户反馈信息列表
+     * @return 表示用户反馈信息列表的 {@link List}{@code <}{@link UserFeedbackDto}{@code >}。
      */
     @GetMapping("/feedbacks")
     public List<UserFeedbackDto> getAllUserFeedbacks() {
         return this.userFeedbackService.getAllUserFeedbacks();
     }
 
     /**
-     * 通过LogId获取对话信息列表
+     * 通过日志唯一标识获取对话信息列表。
      *
-     * @param instanceId 对话实例Id
-     * @return 对话信息
+     * @param instanceId 表示对话实例唯一标识的 {@link String}。
+     * @return 表示对话信息的 {@link UserFeedbackDto}。
      */
     @GetMapping("/feedback/{instanceId}")
     public UserFeedbackDto getAllAnswerByInstanceId(@PathVariable("instanceId") String instanceId) {

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/controller/UserInfoController.java

@@ -19,10 +19,10 @@
 import modelengine.jade.app.engine.base.service.UserInfoService;
 
 /**
- * 用户信息相关控制器
- *
- * @since 2024-5-30
+ * 用户信息相关控制器。
  *
+ * @author 陈潇文
+ * @since 2024-05-30
  */
 @Component
 @RequestMapping("/aipp/user")
@@ -34,10 +34,10 @@ public UserInfoController(UserInfoService userInfoService) {
     }
 
     /**
-     * 创建用户信息记录
+     * 创建用户信息记录。
      *
-     * @param userInfoDto 用户信息消息体
-     * @return 用户信息 id
+     * @param userInfoDto 表示用户信息消息体的 {@link UserInfoDto}。
+     * @return 表示用户信息唯一标识的 {@link Response}{@code <}{@link Long}{@code >}。
      */
     @PostMapping("/info")
     public Response<Long> createUserAppCollection(@RequestBody UserInfoDto userInfoDto) {
@@ -46,10 +46,10 @@ public Response<Long> createUserAppCollection(@RequestBody UserInfoDto userInfoD
     }
 
     /**
-     * 修改用户信息
+     * 修改用户信息。
      *
-     * @param userInfoDto 用户信息消息体
-     * @return 响应信息
+     * @param userInfoDto 表示用户信息消息体的 {@link UserInfoDto}。
+     * @return 表示响应信息的 {@link Response}{@code <}{@link Void}{@code >}。
      */
     @PatchMapping("/info")
     public Response<Void> updateUserAppCollection(@RequestBody UserInfoDto userInfoDto) {
@@ -58,10 +58,10 @@ public Response<Void> updateUserAppCollection(@RequestBody UserInfoDto userInfoD
     }
 
     /**
-     * 获取用户信息记录
+     * 获取用户信息记录。
      *
-     * @param userName 用户名
-     * @return 用户信息
+     * @param userName 表示用户名的 {@link String}。
+     * @return 表示用户信息的 {@link Response}{@code <}{@link UserInfoDto}{@code >}。
      */
     @GetMapping("/info/{userName}")
     public Response<UserInfoDto> createUserAppCollection(@PathVariable("userName") String userName) {

app-builder/plugins/app-base/src/main/java/modelengine/jade/app/engine/base/service/impl/AppBuilderRecommendServiceImpl.java

@@ -33,7 +33,7 @@
 import java.util.List;
 
 /**
- * 猜你想问serviceImpl
+ * 猜你想问服务的实现类。
  *
  * @author 杨海波
  * @since 2024-05-25