From 6171f512514e871d33552af8c484f552b4f030d8 Mon Sep 17 00:00:00 2001
From: Looly <loolly@aliyun.com>
Date: Sat, 10 Aug 2024 09:30:40 +0800
Subject: [PATCH] add comment

---
 .../java/org/dromara/hutool/json/package-info.java     | 10 ++++++++++
 .../dromara/hutool/json/writer/JSONValueWriter.java    |  8 ++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/hutool-json/src/main/java/org/dromara/hutool/json/package-info.java b/hutool-json/src/main/java/org/dromara/hutool/json/package-info.java
index 7e4ecf182..0bdc84e48 100644
--- a/hutool-json/src/main/java/org/dromara/hutool/json/package-info.java
+++ b/hutool-json/src/main/java/org/dromara/hutool/json/package-info.java
@@ -24,6 +24,16 @@
  *               ------mapper----->              ---JSONWriter---->
  * }</pre>
  *
+ * 当然，为了高效转换，如果没有自定义需求，Java对象可以不通过JSON对象与JSON字符串转换：
+ * <ul>
+ *     <li>JSONTokener：JSON字符串底层解析器，通过Stream方式读取JSON字符串并对不同字段自定义处理。</li>
+ *     <li>JSONWriter：JSON字符串底层生成器，可以自定义写出任意对象。</li>
+ * </ul>
+ * <pre>{@code
+ *                <---JSONTokener----
+ *     Java对象    <=================>    JSON字符串
+ *                ---JSONWriter---->
+ * }</pre>
  *
  * @author looly
  *
diff --git a/hutool-json/src/main/java/org/dromara/hutool/json/writer/JSONValueWriter.java b/hutool-json/src/main/java/org/dromara/hutool/json/writer/JSONValueWriter.java
index 835922511..c60560476 100644
--- a/hutool-json/src/main/java/org/dromara/hutool/json/writer/JSONValueWriter.java
+++ b/hutool-json/src/main/java/org/dromara/hutool/json/writer/JSONValueWriter.java
@@ -17,8 +17,12 @@ import java.util.function.Predicate;
 /**
  * JSON的值自定义写出，通过自定义实现此接口，实现对象自定义写出字符串形式<br>
  * 如自定义的一个CustomBean，我只希望输出id的值，此时自定义此接口。<br>
- * 其中{@link JSONValueWriter#test(Object)}负责判断何种对象使用此规则，{@link JSONValueWriter#write(JSONWriter, Object)}负责写出规则。<br>
- * 注意：使用{@link GlobalValueWriters#add(JSONValueWriter)}加入全局转换规则后，在JSON对象中，自定义对象不会被转换，而是原始对象存在。
+ * 其中{@link JSONValueWriter#test(Object)}负责判断何种对象使用此规则，{@link JSONValueWriter#write(JSONWriter, Object)}负责写出规则。
+ *
+ * <p>
+ * 注意：使用{@link GlobalValueWriters#add(JSONValueWriter)}加入全局转换规则后，在JSON对象中，自定义对象不会被转换为JSON。
+ * 而是原始对象存在，只有在生成JSON字符串时才序列化。
+ * </p>
  *
  * @author looly
  * @since 6.0.0