利用Go来给代码生成合适的文档
godoc工具是专门用来从代码生成文档的
如何使用godoc来生成包的文档,还可以看示例代码,来增加测试扩展的维度
比如,我们看json包,json包中有5个示例,示例在包中都有展示
我们也可以创建自己的示例,并在包的Go文档中展示
// 创建示例代码
package handlers_test
import (
“encoding/json”
“fmt”
“log”
“net/http”
“net/http/httptest”
)
// 创建的名字要在同名的函数前面增加一个Example
func ExampleSendJSON() {
r, _ := http.NewRequest(“GET”, “/sendjson”, nil)
w := httptest.NewRecorder()
http.DefaultServeMux.ServeHTTP(w, r)
var u struct {
Name string
Email string
}
if err := json.NewDecoder(w.Body).Decode(&u); err != nil {
log.Println(“ERROR:”, err)
}
//打印来检测输出是否出现问题
fmt.Println(u)
// Output:
// {Bill bill@hotmail.com}
}
基本代码如上
我们使用Example代替Test为函数的开始
然后示例函数必须要基于公开的函数或者方法
Output: 的注释,用来标记在函数运行后期望的输出