创建函数文档模板包括以下步骤：导入模板函数（1），定义函数模板（2），定义函数数据结构（3），解析函数模板（4）。通过解析函数数据结构生成函数文档，确保一致性和简洁性。

如何在 Go 中创建函数文档模板

创建函数文档模板可帮助您在编写 Go 代码时保持一致性和简洁性。以下是创建模板的方法：

1. 从标准库导入模板函数

import (
    "bytes"
    "fmt"
    "io"
    "text/template"
)

2. 定义函数模板

创建一个名为 funcTmpl 的模板：

var funcTmpl = template.Must(template.New("function").Parse(funcTmplStr))

const funcTmplStr = `func {{.Name}}({{.Args}}) {{.Returns}} {
    {{.Body}}
    return {{.ReturnValues}}
}`

3. 定义函数数据结构

创建一个 Func 数据结构来存储函数详细信息：

立即学习“go语言免费学习笔记（深入）”；

type Func struct {
    Name       string
    Args       string
    Returns    string
    Body       string
    ReturnValues string
}

4. 解析函数模板

通过调用 Execute 方法使用函数数据结构解析模板：

func RenderFunctionDoc(w io.Writer, f Func) error {
    var buf bytes.Buffer
    if err := funcTmpl.Execute(&buf, f); err != nil {
        return err
    }
    _, err := buf.WriteTo(w)
    return err
}

实战案例

使用示例 Func 对象生成函数文档：

func main() {
    f := Func{
        Name:       "Sum",
        Args:       "a, b int",
        Returns:    "int",
        Body:       "return a + b",
        ReturnValues: "the sum of a and b",
    }

    if err := RenderFunctionDoc(os.Stdout, f); err != nil {
        fmt.Println(err)
        return
    }
}

输出：

func Sum(a, b int) int {
    return a + b
}