3.6 生成代碼文檔

go doc 工具會從 Go 程序和包文件中提取頂級聲明的首行註釋以及每個對象的相關注釋,並生成相關文檔。

它也可以作爲一個提供在線文檔瀏覽的 web 服務器,http://golang.org 就是通過這種形式實現的。

一般用法

  • go doc package 獲取包的文檔註釋,例如:go doc fmt 會顯示使用 godoc 生成的 fmt 包的文檔註釋。
  • go doc package/subpackage 獲取子包的文檔註釋,例如:go doc container/list
  • go doc package function 獲取某個函數在某個包中的文檔註釋,例如:go doc fmt Printf 會顯示有關 fmt.Printf() 的使用說明。

這個工具只能獲取在 Go 安裝目錄下 .../go/src 中的註釋內容。此外,它還可以作爲一個本地文檔瀏覽 web 服務器。在命令行輸入 godoc -http=:6060,然後使用瀏覽器打開 http://localhost:6060 後,你就可以看到本地文檔瀏覽服務器提供的頁面。

godoc 也可以用於生成非標準庫的 Go 源碼文件的文檔註釋(第 9.6 章)。

如果想要獲取更多有關 godoc 的信息,請訪問該頁面:http://golang.org/cmd/godoc/(在線版的第三方包 godoc 可以使用 Go Walker)。

鏈接

results matching ""

    No results matching ""