建站
咨詢
售后
建站咨詢
新聞中心
這篇文章主要介紹“golang如何獲取注釋內(nèi)容”的相關(guān)知識，小編通過實(shí)際案例向大家展示操作過程，操作方法簡單快捷，實(shí)用性強(qiáng)，希望這篇“golang如何獲取注釋內(nèi)容”文章能幫助大家解決問題。
創(chuàng)新互聯(lián)專業(yè)為企業(yè)提供萬柏林網(wǎng)站建設(shè)、萬柏林做網(wǎng)站、萬柏林網(wǎng)站設(shè)計(jì)、萬柏林網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁設(shè)計(jì)與制作、萬柏林企業(yè)網(wǎng)站模板建站服務(wù)，10年萬柏林做網(wǎng)站經(jīng)驗(yàn)，不只是建網(wǎng)站，更提供有價值的思路和整體網(wǎng)絡(luò)服務(wù)。
在golang中，可以使用godoc工具來提取注釋內(nèi)容。godoc工具會從Go程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關(guān)注釋，并生成相關(guān)文檔，也可以作為一個提供在線文檔瀏覽的web服務(wù)器。
在golang中，可以使用godoc工具來提取注釋內(nèi)容。
godoc工具
godoc 工具會從 Go 程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關(guān)注釋，并生成相關(guān)文檔，也可以作為一個提供在線文檔瀏覽的 web 服務(wù)器，Go語言官網(wǎng)（https://golang.google.cn/）就是通過這種形式實(shí)現(xiàn)的。
需要注意：Go語言 1.13 版本移除了 godoc 工具，大家可以通過go get 命令來獲取 godoc 工具。
go get golang.org/x/tools/cmd/godoc
由于防火墻的原因，國內(nèi)的用戶可能無法通過go get 命令來獲取 godoc 工具，這時候就需要大家來手動操作了。
首先從 GitHub下載 golang.org/x/tools 包；
然后將下載得到的文件解壓到 GOPATH 下的 src\golang.org\x\tools 目錄中，沒有的話可以手動創(chuàng)建；
打開 GOPATH 下的 src\golang.org\x\tools\cmd\godoc 目錄，在該目錄下打開命令行工具，并執(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(h2 string, h3 string) (reValue string)
func Test(param1 string, inter int) (k string)
func Z()
type Computer struct{ ... }
type Person struct{ ... }
BUG: 這個注釋會生成在文檔最后后面，同時因?yàn)榫o跟著fun Z，所以在上面的func列表里面也有顯示
功能: 生成Z簽名
BUG: 因?yàn)榍懊嬗蠦UG(who)這個關(guān)鍵字，所以這句注釋就算沒有緊跟關(guān)鍵字不會被隱藏掉
BUG: BUG(6):格式正確，所以這句注釋就算沒有緊跟關(guān)鍵字不會被隱藏掉，前面的BUG():、BUG6:、BUG:都是不正確的BUG(who)命名
go doc 查看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 : 運(yùn)算的數(shù)字
返回值:
k : 返回值
如果想查看完整的源碼go doc -src
example:
go doc -src test.Test
terminal show:
package test // import "test/testdoc"
// 功能: 測試函數(shù)
// 參 數(shù):
// param1 : 說明參數(shù)值
// inter : 運(yùn)算的數(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/或者127.0.0.1:6060/pkg/
導(dǎo)出godoc文檔為HTML
使用命令godoc -url "http://localhost:6060/pkg/
關(guān)于“golang如何獲取注釋內(nèi)容”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識，可以關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，小編每天都會為大家更新不同的知識點(diǎn)。
網(wǎng)站欄目：golang如何獲取注釋內(nèi)容
標(biāo)題路徑：http://ef60e0e.cn/article/posgoo.html
