From 572226529084f8a42bd35c486fb183e78bcff3e9 Mon Sep 17 00:00:00 2001
From: pswqm3ot6 <2754728380@qq.com>
Date: Wed, 27 Nov 2024 17:59:43 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0/enums=E4=B8=8B=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

对于所有枚举类添加了其作用和目的上的注释
---
 .gitignore                                               | 2 ++
 .../src/main/java/lsgwr/exam/enums/LoginTypeEnum.java    | 8 ++++----
 backend/src/main/java/lsgwr/exam/enums/QuestionEnum.java | 9 ++++-----
 backend/src/main/java/lsgwr/exam/enums/ResultEnum.java   | 8 ++++++++
 backend/src/main/java/lsgwr/exam/enums/RoleEnum.java     | 9 ++++++++-
 5 files changed, 26 insertions(+), 10 deletions(-)

diff --git a/.gitignore b/.gitignore
index a1c2a23..f99cf49 100644
--- a/.gitignore
+++ b/.gitignore
@@ -21,3 +21,5 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+**./.idea
diff --git a/backend/src/main/java/lsgwr/exam/enums/LoginTypeEnum.java b/backend/src/main/java/lsgwr/exam/enums/LoginTypeEnum.java
index 410aa30..5387a27 100644
--- a/backend/src/main/java/lsgwr/exam/enums/LoginTypeEnum.java
+++ b/backend/src/main/java/lsgwr/exam/enums/LoginTypeEnum.java
@@ -3,18 +3,18 @@ package lsgwr.exam.enums;
 import lombok.Getter;
 
 /**
- * 用户账号类型的枚举
- * @author liangshanguang
+ * @Description: 用户账号类型的枚举
  */
 @Getter
 public enum LoginTypeEnum {
     /**
-     * 用户的账号类型，1代表用户名，2代表邮箱
+     * @Description: 用户的账号类型
+     * 1代表用户名，2代表邮箱
      */
     USERNAME(1, "用户名"),
     EMAIL(2, "邮箱");
 
-
+    // 构造函数用于初始化code和description
     LoginTypeEnum(Integer type, String name) {
         this.type = type;
         this.name = name;
diff --git a/backend/src/main/java/lsgwr/exam/enums/QuestionEnum.java b/backend/src/main/java/lsgwr/exam/enums/QuestionEnum.java
index 06f6b5b..4ce5046 100644
--- a/backend/src/main/java/lsgwr/exam/enums/QuestionEnum.java
+++ b/backend/src/main/java/lsgwr/exam/enums/QuestionEnum.java
@@ -8,17 +8,16 @@ package lsgwr.exam.enums;
 
 import lombok.Getter;
 
+/**
+ * @Description : 问题类型
+ */
 @Getter
 public enum QuestionEnum {
-
-    /**
-     * 问题类型
-     */
     RADIO(1, "单选题"),
     CHECK(2, "多选题"),
     JUDGE(3, "判断题");
 
-
+    // 构造函数用于初始化id和role
     QuestionEnum(Integer id, String role) {
         this.id = id;
         this.role = role;
diff --git a/backend/src/main/java/lsgwr/exam/enums/ResultEnum.java b/backend/src/main/java/lsgwr/exam/enums/ResultEnum.java
index 8dacff6..bf69fee 100644
--- a/backend/src/main/java/lsgwr/exam/enums/ResultEnum.java
+++ b/backend/src/main/java/lsgwr/exam/enums/ResultEnum.java
@@ -2,6 +2,9 @@ package lsgwr.exam.enums;
 
 import lombok.Getter;
 
+/**
+ * @Description : 错误码枚举
+ */
 @Getter
 public enum ResultEnum {
     // 下面是本项目用到的所有错误码
@@ -17,6 +20,11 @@ public enum ResultEnum {
     ORDER_UPDATE_ERR(15, "考试更新异常"),
     ORDER_DETAIL_EMPTY(16, "用户详情为空");
 
+    /**
+     * @Description: 构造函数用于初始化错误码code和描述信息message
+     * @param code 错误码
+     * @param message 描述信息
+     */
     ResultEnum(Integer code, String message) {
         this.code = code;
         this.message = message;
diff --git a/backend/src/main/java/lsgwr/exam/enums/RoleEnum.java b/backend/src/main/java/lsgwr/exam/enums/RoleEnum.java
index d37ab8d..3f29b6b 100644
--- a/backend/src/main/java/lsgwr/exam/enums/RoleEnum.java
+++ b/backend/src/main/java/lsgwr/exam/enums/RoleEnum.java
@@ -8,6 +8,9 @@ package lsgwr.exam.enums;
 
 import lombok.Getter;
 
+/**
+ * @Description: 账户身份枚举
+ */
 @Getter
 public enum RoleEnum {
 
@@ -18,7 +21,11 @@ public enum RoleEnum {
     TEACHER(2, "教师"),
     STUDENT(3, "学生");
 
-
+    /**
+     * @Description: 构造函数用于初始化错误码code和描述信息message
+     * @param id 身份id
+     * @param role 身份描述
+     */
     RoleEnum(Integer id, String role) {
         this.id = id;
         this.role = role;