9.6 生成文档和示例代码

一、文档

  1. 命令:go dock 生成文档

  2. 命令:godoc -http :6060 查看文档

    备注:go 1.13中删除了这个方法,如果使用需要额外安装

    go get golang.org/x/tools/cmd/godoc

二、示例代码

  1. 新建一个测试文件

  2. 添加示例代码

    func Example....() {
        // 示例代码内容
        
        // Output:
        // 输出结果。。
        // 输出结果。。
    }

    备注:....表示其他内容,用于标注是什么内容的示例代码

    // Output: 表示示例代码输出 // 输出结果。。 必须填写上面示例代码的输出结果 // 输出结果。。 必须填写上面示例代码的输出结果

  3. 可以通过文档的方式在网页端查看

  4. 示例代码也可以相当于测试

Last updated

Was this helpful?