[3.0.0] (breaking-update) update comments usage.

impl/yaml/src/test/java/config/source/DatabaseConfiguration.java

@@ -1,35 +1,29 @@
 package config.source;
 
 import cc.carm.lib.configuration.core.ConfigurationRoot;
-import cc.carm.lib.configuration.core.annotation.ConfigComment;
 import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
 import cc.carm.lib.configuration.core.value.ConfigValue;
 import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
 
-@ConfigComment({"数据库配置", "  用于提供数据库连接，进行数据库操作。"})
+@HeaderComment({"", "数据库配置", "  用于提供数据库连接，进行数据库操作。"})
 public class DatabaseConfiguration extends ConfigurationRoot {
 
     @ConfigPath("driver")
-    @ConfigComment(value = {
+    @HeaderComment({
             "数据库驱动配置，请根据数据库类型设置。",
             "- MySQL: com.mysql.cj.jdbc.Driver",
             "- MariaDB(推荐): org.mariadb.jdbc.Driver",
-    }, startWrap = false)
+    })
     protected static final ConfigValue<String> DRIVER_NAME = ConfiguredValue.of(
             String.class, "com.mysql.cj.jdbc.Driver"
     );
 
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<String> HOST = ConfiguredValue.of(String.class, "127.0.0.1");
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<Integer> PORT = ConfiguredValue.of(Integer.class, 3306);
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<String> DATABASE = ConfiguredValue.of(String.class, "minecraft");
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<String> USERNAME = ConfiguredValue.of(String.class, "root");
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<String> PASSWORD = ConfiguredValue.of(String.class, "password");
-    @ConfigComment(startWrap = false)
     protected static final ConfigValue<String> EXTRA = ConfiguredValue.of(String.class, "?useSSL=false");
 
     protected static String buildJDBC() {

impl/yaml/src/test/java/config/source/DemoConfiguration.java

@@ -2,8 +2,9 @@ package config.source;
 
 import cc.carm.lib.configuration.core.ConfigInitializer;
 import cc.carm.lib.configuration.core.ConfigurationRoot;
-import cc.carm.lib.configuration.core.annotation.ConfigComment;
 import cc.carm.lib.configuration.core.annotation.ConfigPath;
+import cc.carm.lib.configuration.core.annotation.HeaderComment;
+import cc.carm.lib.configuration.core.annotation.InlineComment;
 import cc.carm.lib.configuration.core.value.ConfigValue;
 import cc.carm.lib.configuration.core.value.type.ConfiguredList;
 import cc.carm.lib.configuration.core.value.type.ConfiguredMap;
@@ -17,22 +18,20 @@ import java.util.Objects;
 import java.util.UUID;
 
 
-@ConfigComment({"给根类添加的注释将显示在文件的末尾。"})
+@HeaderComment({
+        "此处内容将显示在配置文件的最上方",
+        ""/*添加一个空行与其他配置的注释分割*/
+})
 public class DemoConfiguration extends ConfigurationRoot {
 
     @ConfigPath(root = true)
-    @ConfigComment(value = {
-            "有时候，需要在配置文件最上面显示点东西，",
-            "此时就推荐添加一个可以用到但并不重要的参数到最上面",
-            "并给他添加对应的注释。"
-    }, startWrap = false, endWrap = true)
     protected static final ConfigValue<Double> VERSION = ConfiguredValue.of(Double.class, 1.0D);
 
-
     // 支持通过 Class<?> 变量标注子配置，一并注册。
     // 注意： 若对应类也有注解，则优先使用类的注解。
     @ConfigPath("impl-test") //支持通过注解修改子配置的主路径，若不修改则以变量名自动生成。
-    @ConfigComment("Something...") // 支持给子路径直接打注释
+    @HeaderComment({"", "Something..."}) // 支持给子路径直接打注释
+    @InlineComment("InlineComments for class path")
     public static final Class<?> IMPL = ImplConfiguration.class;
 
     // 子配置文件
@@ -40,14 +39,15 @@ public class DemoConfiguration extends ConfigurationRoot {
     public static final Class<?> DB_CONFIG = DatabaseConfiguration.class;
 
     @ConfigPath("user") // 通过注解规定配置文件中的路径，若不进行注解则以变量名自动生成。
-    @ConfigComment({"Section类型数据测试"}) // 通过注解给配置添加注释。
+    @HeaderComment({"", "Section类型数据测试"}) // 通过注解给配置添加注释。
+    @InlineComment("Section数据也支持InlineComment注释")
     public static final ConfigValue<TestModel> MODEL_TEST = ConfiguredSection
             .builder(TestModel.class)
             .defaults(new TestModel("Carm", UUID.randomUUID()))
             .parseValue((section, defaultValue) -> TestModel.deserialize(section))
             .serializeValue(TestModel::serialize).build();
 
-    @ConfigComment({"[ID-UUID] 对照表", "", "用于测试Map类型的解析与序列化保存"})
+    @HeaderComment({"", "[ID - UUID]对照表", "", "用于测试Map类型的解析与序列化保存"})
     public static final ConfigValue<Map<Integer, UUID>> USERS = ConfiguredMap
             .builder(Integer.class, UUID.class).fromString()
             .parseKey(Integer::parseInt)
@@ -62,6 +62,7 @@ public class DemoConfiguration extends ConfigurationRoot {
     public static class Sub extends ConfigurationRoot {
 
         @ConfigPath(value = "uuid-value", root = true)
+        @InlineComment("This is an inline comment")
         public static final ConfigValue<UUID> UUID_CONFIG_VALUE = ConfiguredValue
                 .builder(UUID.class).fromString()
                 .parseValue((data, defaultValue) -> UUID.fromString(data))

impl/yaml/src/test/java/config/source/ImplConfiguration.java

@@ -10,7 +10,9 @@ import config.model.TestModel;
 @ConfigPath(root = true)
 public class ImplConfiguration extends ConfigurationRoot {
 
-    public static final ConfigValue<? extends AbstractModel> TEST = ConfiguredSerializable.of(TestModel.class, TestModel.random());
+    public static final ConfigValue<? extends AbstractModel> TEST = ConfiguredSerializable.of(
+            TestModel.class, TestModel.random()
+    );
 
 
 }