From db004a23b0903fdc53c90ba46dd00eb121801661 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AE=B8=E8=BD=B2?= <luke.k.xu@hotmail.com>
Date: Wed, 11 Oct 2023 02:11:33 +0800
Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=20ConfigController.java=20?=
 =?UTF-8?q?=E7=9A=84=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../interfaces/ConfigController.java          | 25 ++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/jcnc/jnotepad/api/core/controller/interfaces/ConfigController.java b/src/main/java/org/jcnc/jnotepad/api/core/controller/interfaces/ConfigController.java
index e4b110a..7691b5d 100644
--- a/src/main/java/org/jcnc/jnotepad/api/core/controller/interfaces/ConfigController.java
+++ b/src/main/java/org/jcnc/jnotepad/api/core/controller/interfaces/ConfigController.java
@@ -4,22 +4,36 @@ import java.nio.file.Path;
 
 /**
  * 配置文件控制器接口
+ * <p>
+ * 该接口定义了配置文件相关的操作，包括加载、持久化、创建和获取配置文件路径等。
+ * </p>
+ *
+ * @param <T> 配置文件类型
  *
  * @author gewuyou
  */
 public interface ConfigController<T> {
     /**
      * 加载配置文件内容
+     * <p>
+     * 从配置文件中加载配置信息。
+     * </p>
      */
     void loadConfig();
 
     /**
      * 配置文件持久化
+     * <p>
+     * 将配置信息持久化到配置文件中。
+     * </p>
      */
     void writeConfig();
 
     /**
      * 配置文件持久化
+     * <p>
+     * 将指定的配置对象持久化到配置文件中。
+     * </p>
      *
      * @param config 配置文件对象
      */
@@ -27,19 +41,28 @@ public interface ConfigController<T> {
 
     /**
      * 如果配置文件不存在则创建
+     * <p>
+     * 在需要的情况下创建配置文件，如果配置文件已存在，则不执行任何操作。
+     * </p>
      */
     void createConfigIfNotExists();
 
     /**
      * 创建配置文件实体
+     * <p>
+     * 生成默认的配置文件实体对象，用于后续的序列化操作。
+     * </p>
      *
      * @return 默认的配置文件实体
-     * @apiNote 返回默认的配置文件实体用于序列化json
+     * @apiNote 返回默认的配置文件实体用于序列化 JSON 数据。
      */
     T generateDefaultConfig();
 
     /**
      * 获取配置文件路径
+     * <p>
+     * 返回配置文件的路径。
+     * </p>
      *
      * @return 配置文件路径
      */