添加文档

yaml/yaml_loader/yaml_loader.go

@@ -10,6 +10,12 @@ import (
 	"reflect"
 )
 
+// LoadYamlFile 加载YAML文件，一个文件中可以有多个YAML对象
+// 参数：
+// yamlFilePath: YAML文件路径
+// retObjects: 用来接收YAML对象的指针或者map的slice
+// 返回值：
+// 错误
 func LoadYamlFile(yamlFilePath string, retObjects *[]any) error {
 	yamlFile, err := os.Open(yamlFilePath)
 	if err != nil {
@@ -26,6 +32,12 @@ func LoadYamlFile(yamlFilePath string, retObjects *[]any) error {
 	return loadYaml(yamlFile, retObjects)
 }
 
+// LoadYamlBytes 加载YAML文件字节，一个文件中可以有多个YAML对象
+// 参数：
+// yamlBytes: YAML文件的字节
+// retObjects: 用来接收YAML对象的指针或者map的slice
+// 返回值：
+// 错误
 func LoadYamlBytes(yamlBytes []byte, retObjects *[]any) error {
 	return loadYaml(bytes.NewReader(yamlBytes), retObjects)
 }
@@ -39,7 +51,7 @@ func loadYaml(r io.Reader, retObjects *[]any) error {
 		retObjectType := reflect.TypeOf(retObject)
 
 		if retObjectType.Kind() != reflect.Ptr && retObjectType.Kind() != reflect.Map {
-			return errors.New("返回对象slice元素需要指针或者map")
+			return errors.New("返回对象slice需要指针或者map")
 		}
 
 		err := decoder.Decode(retObject)