refactor(core-bukkit): 修改方法名称，添加部分文档

core-bukkit/src/main/java/cn/hamster3/mc/plugin/core/bukkit/constant/CoreMessage.java

@@ -79,11 +79,11 @@ public enum CoreMessage {
             ConfigurationSection section = config.getConfigurationSection(value.name());
             if (section == null) {
                 plugin.getLogger().info("生成消息设置: " + value.name());
-                config.set(value.name(), CoreBukkitUtils.toDisplayMessage(value.message));
+                config.set(value.name(), CoreBukkitUtils.saveDisplayMessage(value.message));
                 continue;
             }
             try {
-                value.message = CoreBukkitUtils.getDisplayMessage(section);
+                value.message = CoreBukkitUtils.loadDisplayMessage(section);
             } catch (Exception e) {
                 plugin.getLogger().warning("加载消息设置 " + value.name() + " 时遇到了一个异常: ");
                 e.printStackTrace();

core-bukkit/src/main/java/cn/hamster3/mc/plugin/core/bukkit/util/CoreBukkitUtils.java

@@ -186,8 +186,27 @@ public final class CoreBukkitUtils {
         }
     }
 
+    /**
+     * 从 config 中加载 DisplayMessage 实例
+     *
+     * @param config 配置
+     * @return DisplayMessage 实例
+     * @deprecated 使用 {@link #loadDisplayMessage(ConfigurationSection)}
+     */
+    @Deprecated
     @NotNull
     public static DisplayMessage getDisplayMessage(@NotNull ConfigurationSection config) {
+        return loadDisplayMessage(config);
+    }
+
+    /**
+     * 从 config 中加载 DisplayMessage 实例
+     *
+     * @param config 配置
+     * @return DisplayMessage 实例
+     */
+    @NotNull
+    public static DisplayMessage loadDisplayMessage(@NotNull ConfigurationSection config) {
         DisplayMessage displayMessage = new DisplayMessage();
         String message = config.getString("message");
         if (message != null) {
@@ -218,8 +237,14 @@ public final class CoreBukkitUtils {
         return displayMessage;
     }
 
+    /**
+     * 将 DisplayMessage 实例保存到 config 中
+     *
+     * @param message DisplayMessage 实例
+     * @return config 节点
+     */
     @NotNull
-    public static ConfigurationSection toDisplayMessage(@NotNull DisplayMessage message) {
+    public static ConfigurationSection saveDisplayMessage(@NotNull DisplayMessage message) {
         YamlConfiguration config = new YamlConfiguration();
         if (message.getMessage() != null) {
             config.set("message", LegacyComponentSerializer.legacySection().serialize(message.getMessage()));
@@ -245,8 +270,19 @@ public final class CoreBukkitUtils {
         return config;
     }
 
-
-    public static Component getItemNameComponent(ItemStack stack) {
+    /**
+     * 获取物品名称的 Component
+     * <p>
+     * 当物品拥有 displayName 时，返回 displayName 的普通文本
+     * <p>
+     * 否则返回翻译文本，以显示客户端的不同语言中物品的原版名称
+     * <p>
+     * 当物品为 null 时，返回 block.minecraft.air 翻译文本
+     *
+     * @param stack 物品
+     * @return 物品名称的 Component
+     */
+    public static Component getItemNameComponent(@Nullable ItemStack stack) {
         if (isEmptyItemStack(stack)) {
             return Component.translatable("block.minecraft.air");
         }