注释后端代码

backend/src/main/java/lsgwr/exam/qo/DownloadQo.java

@@ -13,5 +13,8 @@ import lombok.NoArgsConstructor;
 @AllArgsConstructor
 @NoArgsConstructor
 public class DownloadQo {
+    /**
+     * 文件路径
+     */
     String path;
 }

backend/src/main/java/lsgwr/exam/repository/PageRepository.java

@@ -8,6 +8,8 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.Page;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 页面数据库操作类
+ */
 public interface PageRepository extends JpaRepository<Page, Integer> {
 }

backend/src/main/java/lsgwr/exam/repository/QuestionCategoryRepository.java

@@ -8,6 +8,8 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.QuestionCategory;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 题目分类持久层接口
+ */
 public interface QuestionCategoryRepository extends JpaRepository<QuestionCategory, Integer> {
 }

backend/src/main/java/lsgwr/exam/repository/QuestionLevelRepository.java

@@ -8,6 +8,8 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.QuestionLevel;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 题目难度的持久层接口
+ */
 public interface QuestionLevelRepository extends JpaRepository<QuestionLevel, Integer> {
 }

backend/src/main/java/lsgwr/exam/repository/QuestionOptionRepository.java

@@ -8,6 +8,8 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.QuestionOption;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 题目选项的持久层接口
+ */
 public interface QuestionOptionRepository extends JpaRepository<QuestionOption, String> {
 }

backend/src/main/java/lsgwr/exam/repository/QuestionRepository.java

@@ -11,7 +11,9 @@ import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Query;
 
 import java.util.List;
-
+/**
+ * 题目接口
+ */
 public interface QuestionRepository extends JpaRepository<Question, String> {
     List<Question> findByQuestionTypeId(Integer id);
     @Query("select q from Question q order by q.updateTime desc")

backend/src/main/java/lsgwr/exam/repository/QuestionTypeRepository.java

@@ -8,6 +8,8 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.QuestionType;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 题目类型接口
+ */
 public interface QuestionTypeRepository extends JpaRepository<QuestionType, Integer> {
 }

backend/src/main/java/lsgwr/exam/repository/RoleRepository.java

@@ -9,5 +9,8 @@ package lsgwr.exam.repository;
 import lsgwr.exam.entity.Role;
 import org.springframework.data.jpa.repository.JpaRepository;
 
+/**
+ * 角色的数据库操作类
+ */
 public interface RoleRepository extends JpaRepository<Role, Integer> {
 }

backend/src/main/java/lsgwr/exam/repository/UserRepository.java

@@ -8,7 +8,9 @@ package lsgwr.exam.repository;
 
 import lsgwr.exam.entity.User;
 import org.springframework.data.jpa.repository.JpaRepository;
-
+/**
+ * 用户表的操作类
+ */
 public interface UserRepository extends JpaRepository<User, String> {
     /**
      * 根据用户名查找到合适的用户

backend/src/main/java/lsgwr/exam/service/impl/UserServiceImpl.java

@@ -47,7 +47,12 @@ public class UserServiceImpl implements UserService {
     @Autowired
     ActionRepository actionRepository;
 
-
+    /**
+     * 注册用户
+     *
+     * @param registerDTO 前端传来的注册信息
+     * @return 注册成功返回用户信息，失败返回null
+     */
     @Override
     public User register(RegisterDTO registerDTO) {
         try {
@@ -106,7 +111,12 @@ public class UserServiceImpl implements UserService {
         }
         return null;
     }
-
+    /**
+     * 获取用户信息
+     *
+     * @param userId 用户id
+     * @return 用户信息
+     */
     @Override
     public UserVo getUserInfo(String userId) {
         User user = userRepository.findById(userId).orElse(null);
@@ -115,7 +125,12 @@ public class UserServiceImpl implements UserService {
         BeanUtils.copyProperties(user, userVo);
         return userVo;
     }
-
+    /**
+     * 获取用户详细信息
+     *
+     * @param userId 用户id
+     * @return 用户详细信息
+     */
     @Override
     public UserInfoVo getInfo(String userId) {
         User user = userRepository.findById(userId).orElse(null);

backend/src/main/java/lsgwr/exam/utils/ResultVOUtil.java

@@ -7,22 +7,32 @@
 package lsgwr.exam.utils;
 
 import lsgwr.exam.vo.ResultVO;
-
+/**
+ * 封装返回结果
+ */
 public class ResultVOUtil {
-
+    /**
+     * 成功返回结果
+     */
     public static ResultVO success(Integer code, String msg, Object object) {
         return new ResultVO(code, msg, object);
     }
-
+    /**
+     * 成功返回结果
+     */
     public static ResultVO success(Object object) {
         return new ResultVO(0, "成功", object);
     }
-
+    /**
+     * 成功返回结果
+     */
     public static ResultVO success() {
         return new ResultVO(0, "成功", null);
     }
 
-
+    /**
+     * 失败返回结果
+     */
     public static ResultVO error(Integer code, String msg) {
         return new ResultVO(code, msg, null);
     }

backend/src/main/java/lsgwr/exam/vo/ActionVo.java

@@ -8,15 +8,24 @@ package lsgwr.exam.vo;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
-
+/**
+ * Action前端展示类
+ */
 @Data
 public class ActionVo {
+    /**
+     * 动作名称
+     */
     @JsonProperty("action")
     private String actionName;
-
+    /**
+     * 动作描述
+     */
     @JsonProperty("describe")
     private String actionDescription;
-
+    /**
+     * 是否默认选中
+     */
     @JsonProperty("defaultCheck")
     private Boolean defaultCheck;
 }

backend/src/main/java/lsgwr/exam/vo/JsonData.java

@@ -16,7 +16,9 @@ import java.io.Serializable;
 @AllArgsConstructor
 @NoArgsConstructor
 public class JsonData implements Serializable {
-
+    /**
+     * 序列化id
+     */
     private static final long serialVersionUID = 1L;
 
     /**

backend/src/main/java/lsgwr/exam/vo/PageVo.java

@@ -10,15 +10,24 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 页面展示类
+ */
 @Data
 public class PageVo {
+    /**
+     * 页面动作集合
+     */
     @JsonProperty("actionEntitySet")
     private List<ActionVo> actionVoList;
-
+    /**
+     * 页面名称，即路由名称
+     */
     @JsonProperty("permissionId")
     private String pageName;
-
+    /**
+     * 页面描述，即路由描述
+     */
     @JsonProperty("permissionName")
     private String pageDescription;
 }

backend/src/main/java/lsgwr/exam/vo/QuestionCreateSimplifyVo.java

@@ -10,7 +10,9 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 问题创建的实体类,简化了下
+ */
 @Data
 public class QuestionCreateSimplifyVo {
     /**

backend/src/main/java/lsgwr/exam/vo/QuestionCreateVo.java

@@ -10,7 +10,9 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 创建问题的实体类
+ */
 @Data
 public class QuestionCreateVo {
     /**

backend/src/main/java/lsgwr/exam/vo/QuestionDetailVo.java

@@ -11,7 +11,9 @@ import lombok.Data;
 
 import java.util.ArrayList;
 import java.util.List;
-
+/**
+ * 问题详情的实体类
+ */
 @Data
 public class QuestionDetailVo {
     /**

backend/src/main/java/lsgwr/exam/vo/QuestionOptionCreateVo.java

@@ -8,7 +8,9 @@ package lsgwr.exam.vo;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
-
+/**
+ * 问题选项的外层对象
+ */
 @Data
 public class QuestionOptionCreateVo {
 

backend/src/main/java/lsgwr/exam/vo/QuestionOptionVo.java

@@ -8,18 +8,29 @@ package lsgwr.exam.vo;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
-
+/**
+ * 问题选项的自定义实体类
+ */
 @Data
 public class QuestionOptionVo {
+    /**
+     * 问题选项的id
+     */
     @JsonProperty("id")
     private String questionOptionId;
-
+    /**
+     * 问题选项的内容
+     */
     @JsonProperty("content")
     private String questionOptionContent;
-
+    /**
+     * 问题选项是否是答案
+     */
     @JsonProperty("answer")
     private Boolean answer = false;
-
+    /**
+     * 问题选项的描述
+     */
     @JsonProperty("description")
     private String questionOptionDescription;
 }

backend/src/main/java/lsgwr/exam/vo/QuestionPageVo.java

@@ -10,7 +10,9 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 问题列表反馈给前端的对象
+ */
 @Data
 public class QuestionPageVo {
 

backend/src/main/java/lsgwr/exam/vo/QuestionSelectionVo.java

@@ -13,15 +13,24 @@ import lsgwr.exam.entity.QuestionType;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 前端创建问题时的下拉列表选择
+ */
 @Data
 public class QuestionSelectionVo {
+    /**
+     * 问题类型
+     */
     @JsonProperty("types")
     private List<QuestionType> questionTypeList;
-
+    /**
+     * 问题分类
+     */
     @JsonProperty("categories")
     private List<QuestionCategory> questionCategoryList;
-
+    /**
+     * 问题难度
+     */
     @JsonProperty("levels")
     private List<QuestionLevel> questionLevelList;
 }

backend/src/main/java/lsgwr/exam/vo/QuestionVo.java

@@ -12,15 +12,24 @@ import lombok.Data;
 
 import java.util.Date;
 import java.util.List;
-
+/**
+ * 问题的VO类，用于返回给前端
+ */
 @Data
 public class QuestionVo {
+    /**
+     * 问题id，从数据库表question中获取
+     */
     @JsonProperty("id")
     private String questionId;
-
+    /**
+     * 问题名称，从数据库表question中获取
+     */
     @JsonProperty("name")
     private String questionName;
-
+    /**
+     * 问题分值，从数据库表question中获取
+     */
     @JsonProperty("score")
     private Integer questionScore;
 

backend/src/main/java/lsgwr/exam/vo/RecordDetailVo.java

@@ -11,7 +11,9 @@ import lombok.Data;
 
 import java.util.HashMap;
 import java.util.List;
-
+/**
+ * 考试记录详情的VO
+ */
 @Data
 public class RecordDetailVo {
     /**

backend/src/main/java/lsgwr/exam/vo/ResultVO.java

@@ -13,7 +13,12 @@ import lombok.Data;
 @JsonInclude(JsonInclude.Include.NON_NULL) // 避免返回NULL的字段
 public class ResultVO<T> {
 
-
+    /**
+     * 构造函数
+     * @param code 错误码
+     * @param msg 提示信息
+     * @param data 具体内容
+     */
     public ResultVO(Integer code, String msg, T data) {
         this.code = code;
         this.msg = msg;

backend/src/main/java/lsgwr/exam/vo/RoleVo.java

@@ -10,18 +10,29 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
 
 import java.util.List;
-
+/**
+ * 角色的VO类
+ */
 @Data
 public class RoleVo {
+    /**
+     * 角色名
+     */
     @JsonProperty("id")
     private String roleName;
-
+    /**
+     * 角色描述
+     */
     @JsonProperty("name")
     private String roleDescription;
-
+    /**
+     * 角色的详细描述
+     */
     @JsonProperty("describe")
     private String roleDetail;
-
+    /**
+     * 角色所拥有的权限
+     */
     @JsonProperty("permissions")
     private List<PageVo> pageVoList;
 }

backend/src/main/java/lsgwr/exam/vo/UserInfoVo.java

@@ -8,19 +8,29 @@ package lsgwr.exam.vo;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
-
+/**
+ * 用户信息展示类
+ */
 @Data
 public class UserInfoVo {
-
+    /**
+     * 用户ID，唯一
+     */
     @JsonProperty("id")
     private String userId;
-
+    /**
+     * 头像URL
+     */
     @JsonProperty("avatar")
     private String userAvatar;
-
+    /**
+     * 用户名，唯一
+     */
     @JsonProperty("name")
     private String userNickname;
-
+    /**
+     * 账号，唯一
+     */
     @JsonProperty("username")
     private String userUsername;
 

backend/src/main/java/lsgwr/exam/vo/UserVo.java

@@ -8,30 +8,49 @@ package lsgwr.exam.vo;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
-
+/**
+ * 用户信息展示类
+ */
 @Data
 public class UserVo {
+    /**
+     * 用户ID
+     */
     @JsonProperty("id")
     private String userId;
-
+    /**
+     * 用户名
+     */
     @JsonProperty("username")
     private String userUsername;
-
+    /**
+     * 昵称
+     */
     @JsonProperty("nickname")
     private String userNickname;
-
+    /**
+     * 角色ID
+     */
     @JsonProperty("role")
     private Integer userRoleId;
-
+    /**
+     * 头像
+     */
     @JsonProperty("avatar")
     private String userAvatar;
-
+    /**
+     * 个人简介
+     */
     @JsonProperty("description")
     private String userDescription;
-
+    /**
+     * 邮箱
+     */
     @JsonProperty("email")
     private String userEmail;
-
+    /**
+     * 电话
+     */
     @JsonProperty("phone")
     private String userPhone;
 }