From 9de616194b5f167edcaa1cfa4855ad47442ea1fa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=99=BD=E8=8C=B6=E6=B8=85=E6=AC=A2?=
 <go_developer@163.com>
Date: Tue, 3 Sep 2024 12:02:13 +0800
Subject: [PATCH] update doc

---
 api2sql/execute.go | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/api2sql/execute.go b/api2sql/execute.go
index 7e8b37c..0e248f3 100644
--- a/api2sql/execute.go
+++ b/api2sql/execute.go
@@ -70,7 +70,22 @@ func (e *execute) Run(ctx context.Context, inputParam *define.Api2SqlParam) (any
 	}
 }
 
-// List 列表
+// List 方法用于从数据库中查询数据列表。
+//
+//	参数:
+//	- ctx: 上下文对象，用于传递请求的上下文信息。
+//	- inputParam: 查询参数，包含 SQL 语句、列列表等信息。
+//
+//	返回值:
+//	- any: 查询结果，返回一个结构体切片，其中包含查询到的数据。
+//	- error: 错误信息，如果查询过程中发生错误，将返回相应的错误对象。
+//
+//	使用示例:
+//	result, err := e.List(ctx, inputParam)
+//	if err!= nil {
+//		// 处理错误
+//	}
+//	// 处理查询结果
 //
 // Author : go_developer@163.com<白茶清欢>
 //