go doc
工具會從 Go 程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關(guān)注釋,并生成相關(guān)文檔。
它也可以作為一個提供在線文檔瀏覽的 web 服務(wù)器,http://golang.org 就是通過這種形式實現(xiàn)的。
一般用法
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()
的使用說明。這個工具只能獲取在 Go 安裝目錄下 ../go/src
中的注釋內(nèi)容。此外,它還可以作為一個本地文檔瀏覽 web 服務(wù)器。在命令行輸入 godoc -http=:6060
,然后使用瀏覽器打開 http://localhost:6060 后,你就可以看到本地文檔瀏覽服務(wù)器提供的頁面。
godoc
也可以用于生成非標(biāo)準(zhǔn)庫的 Go 源碼文件的文檔注釋(第 9.6 章)。
如果想要獲取更多有關(guān) godoc
的信息,請訪問該頁面:http://golang.org/cmd/godoc/(在線版的第三方包 godoc
可以使用 Go Walker)。