一、go doc簡介
Godoc是go語言的文檔化工具，類似於文檔化工具godoc，類似於Python的Docstring和Java的Javadoc
Godoc通過解析包含注釋的Go代碼來生成HTML或文本類型的文檔。
二、約定規則
godoc
Go的注釋規則很簡單，為類型，變量，常量，函數或包編寫注釋時，直接在這些聲明前編寫普通形式的注釋，中間不留空行即可。Godoc將這些注釋與后面的聲明連接到一起，達到文檔化的目的。
1.注釋符// 后加空格
// 這是一行注釋
package main
2.注釋緊鄰關鍵字行寫，否則不會被識別
// 不會被識別
// 會被識別
package main
// 不會被識別
// 會被識別1
// 會被識別2
func main（）{
}
3.注釋行的數量最好不要超過3行
4.已知bug注釋：BUG(who)
godoc的輸出將忽略那些與頂層聲明不相鄰的注釋，只有一個例外，那就是以BUG(who)開頭的注釋。這些注釋將被識別為已知的bug，並包含在文檔的BUGS區。
// 注釋
package main
// BUG(who) //會被識別，放入文檔的Bugs區
const a = 8
三、使用命令
首先在命令行進入所需要執行的.go文檔目錄
例：我的test.go放在C:/GoProject/src/test/ 目錄下
需要在命令行進入C:/GoProject/src/test/
然后執行命令
godoc -http=:6060 //6060是godoc提供的默認端口
在瀏覽器輸入 localhost:6060
，即可進入godoc的網站，查看自己的文檔需要在地址欄輸入路徑 localhost:6060/pkg/test