在golang中，可以使用godoc工具來提取注釋內(nèi)容。godoc工具會從Go程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關(guān)注釋，并生成相關(guān)文檔，也可以作為一個提供在線文檔瀏覽的web服務(wù)器。

本教程操作環(huán)境：windows10系統(tǒng)、GO 1.18版本、Dell G3電腦。

在golang中，可以使用godoc工具來提取注釋內(nèi)容。

godoc工具

godoc 工具會從 Go 程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關(guān)注釋，并生成相關(guān)文檔，也可以作為一個提供在線文檔瀏覽的 web 服務(wù)器，Go語言官網(wǎng)（https://golang.google.cn/）就是通過這種形式實現(xiàn)的。

需要注意：Go語言 1.13 版本移除了 godoc 工具，大家可以通過go get 命令來獲取 godoc 工具。

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

由于防火墻的原因，國內(nèi)的用戶可能無法通過go get 命令來獲取 godoc 工具，這時候就需要大家來手動操作了。

• 首先從 GitHub（https://github.com/golang/tools.git） 下載 golang.org/x/tools 包；

• 然后將下載得到的文件解壓到 GOPATH 下的 srcgolang.orgxtools 目錄中，沒有的話可以手動創(chuàng)建；

• 打開 GOPATH 下的 srcgolang.orgxtoolscmdgodoc 目錄，在該目錄下打開命令行工具，并執(zhí)行g(shù)o build 命令，生成 godoc.exe 可執(zhí)行文件；

• 最后，將生成的 godoc.exe 文件移動到 GOPATH 下的 bin 目錄中。（需要把 GOPATH 下的 bin 目錄添加到環(huán)境變量 Path 中）

完成上述操作后就可以使用 godoc 工具了，godoc 工具一般有以下幾種用法：

• go doc package：獲取包的文檔注釋，例如go doc fmt 會顯示使用 godoc 生成的 fmt 包的文檔注釋；

• go doc package/subpackage：獲取子包的文檔注釋，例如go doc container/list；

• go doc package function：獲取某個函數(shù)在某個包中的文檔注釋，例如go doc fmt Printf 會顯示有關(guān) fmt.Printf() 的使用說明。

godoc 工具還可以獲取 Go 安裝目錄下 ../go/src 中的注釋內(nèi)容，并將這些注釋內(nèi)容整合到 web 服務(wù)器中供我們預(yù)覽。在命令行輸入godoc -http=:6060，然后使用瀏覽器打開 http://localhost:6060 后，就可以看到本地文檔瀏覽服務(wù)器提供的頁面。

godoc的使用

在終端查看

在終端，進(jìn)入要查看的包的目錄go doc顯示當(dāng)前包的文檔

這里查看的是包名的文檔，以及所有的函數(shù)名字跟變量類型名

example:     go doc      terminal show:     package test // import "test/testdoc"     這個是a.go的包名的描述       At 20191017 by Baiyu          ---a.go end---          這個是在doc.go 文件中的內(nèi)容          在Go的源代碼中          在Mac系統(tǒng)中          在類Unix系統(tǒng)中          在Windows系統(tǒng)中          ---doc.go end---          這個是在testgodoc.go文件的內(nèi)容 package Name: test              describe:    程序的入口          ---testgodoc.go end---          這個是z.go 的包名描述          ---z.go end---          const Email ...     const Baiyu = "baiyu"     func H(h1 string, h2 string) (reValue string)     func Test(param1 string, inter int) (k string)     func Z()     type Computer struct{ ... }     type Person struct{ ... }          BUG: 這個注釋會生成在文檔最后后面，同時因為緊跟著fun Z，所以在上面的func列表里面也有顯示     功能: 生成Z簽名          BUG: 因為前面有BUG(who)這個關(guān)鍵字，所以這句注釋就算沒有緊跟關(guān)鍵字不會被隱藏掉          BUG: BUG(6):格式正確，所以這句注釋就算沒有緊跟關(guān)鍵字不會被隱藏掉，前面的BUG():、BUG6:、BUG:都是不正確的BUG(who)命名

go doc <pkg>.<func>查看pkg包下面的func函數(shù)的注釋

example:     go doc test.Test      terminal show:      package test // import "test/testdoc"      func Test(param1 string, inter int) (k string)         功能: 測試函數(shù)             參  數(shù):             param1  : 說明參數(shù)值             inter   : 運算的數(shù)字         返回值:             k       : 返回值

如果想查看完整的源碼go doc -src <pkg>.<func>

example:      go doc -src test.Test       terminal show:     package test // import "test/testdoc"     // 功能: 測試函數(shù)     //  參  數(shù):     //      param1  : 說明參數(shù)值     //      inter   : 運算的數(shù)字     //  返回值:     //      k       : 返回值     func Test(param1 string, inter int) (k string) {             fmt.Println("測試函數(shù)")             return param1     }

在瀏覽器上查看

使用命令godoc -http=:6060

然后在打開瀏覽器的，在url輸入localhost:6060/pkg或者127.0.0.1:6060/pkg就可以查看到你本地的所有包的信息了

如果你想要找到你特定的包名的話localhost:6060/pkg/<path>/<packageName>或者127.0.0.1:6060/pkg/<path>/<packageName>

• <path>是你/src下包所在的路徑

• <packageName>是包名

導(dǎo)出godoc文檔為HTML

使用命令godoc -url "http://localhost:6060/pkg/<pkg>/<packageName>/" > <packageName>.html

• <pkg>是你包所在的文件夾

• <packageName>是你的包名

導(dǎo)出來的是純html文件，沒有樣式表，不過也有可能可以導(dǎo)出，但是我目前沒有找到，如果有找到的朋友也可以交流一下

不過我也有把對應(yīng)的樣式文件給導(dǎo)出來了

下載地址https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile

然后把html文件里面的css跟js指定的路徑修改好就可以

【