GO学习笔记-10 工具

godoc

godoc 命令用于查看文档，他有多个参数，常用的是 godoc -http :8080 访问 8080 端口就可以看到所有文档，不仅能看到标准库的文档，还有个 GOPATH src 下程序的文档

为代码添加文档

为代码添写注释文档，只需要使用 //注释，就会在 godoc 中显示出来，在包名上添加 //包作用简介，注意：它只会整理可导出变量的文档，// 后使用制表符，会为文档添加代码缩进

生成测试用例

为函数生成测试用例

demo 包下 demo.go 文件

    // 用于文档的测试包
    //	c := demo.Sum(a,b)
    package demo

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

demo 包下 demo_test.go 文件

    func ExampleSum() {
        tests := []struct {
            a, b int
        }{
            {1, 2},
            {2, 3},
        }

        for _, v := range tests {
            fmt.Printf("%d", Sum(v.a, v.b))
        }

        // output:
        // 3
        // 5
    }

生成测试用例的函数必须以 Example 开头，output 用于定义输出