From 492be493225be5a863fa959cee6d289945ac5751 Mon Sep 17 00:00:00 2001
From: ZhouXY108 <luquanlion@outlook.com>
Date: Sun, 31 May 2026 05:56:32 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=20SimpleJdbcTemplate?=
 =?UTF-8?q?=20=E7=B1=BB=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../xyz/zhouxy/jdbc/SimpleJdbcTemplate.java     | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/src/main/java/xyz/zhouxy/jdbc/SimpleJdbcTemplate.java b/src/main/java/xyz/zhouxy/jdbc/SimpleJdbcTemplate.java
index c6cf363..cfc2aa0 100644
--- a/src/main/java/xyz/zhouxy/jdbc/SimpleJdbcTemplate.java
+++ b/src/main/java/xyz/zhouxy/jdbc/SimpleJdbcTemplate.java
@@ -29,14 +29,27 @@ import javax.sql.DataSource;
 import xyz.zhouxy.plusone.commons.util.AssertTools;
 
 /**
- * SimpleJdbcTemplate
+ * JDBC 操作的模板类，对原生 JDBC 进行轻量封装，提供查询、更新、批量操作等便捷方法。
  *
  * <p>
- * 对 JDBC 的简单封装，方便数据库操作，支持事务，支持批量操作，支持自定义结果集映射
+ * 主要能力：
+ * <ul>
+ * <li>查询：支持 {@link ResultHandler} 自定义结果处理、{@link RowMapper} 行映射等多种方式</li>
+ * <li>更新：执行 INSERT / UPDATE / DELETE，支持返回自增主键</li>
+ * <li>批量操作：通过 {@link #batchUpdate} 分批执行 DML，支持静默模式（遇错继续）和
+ *     非静默模式（遇错即中断）</li>
+ * <li>事务：通过 {@link #transaction()} 获取 {@link TransactionTemplate} 执行</li>
+ * </ul>
+ *
+ * <p>
+ * 线程安全：本类无内部可变状态，线程安全。所依赖的 {@link DataSource}
+ * 需自行保证线程安全。
  *
  * @author ZhouXY
  * @since 1.0.0
+ * @see JdbcOperations
  * @see TransactionTemplate
+ * @see ParamBuilder
  */
 public class SimpleJdbcTemplate implements JdbcOperations {