golang學習之產生代碼文檔

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

go doc 工具會從 Go 程式和包檔案中提取頂級聲明的首行注釋以及每個對象的相關注釋，並產生相關文檔。

一般用法：

• 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() 的使用說明。

在命令列輸入 godoc -http=:6060，然後使用瀏覽器開啟 http://localhost:6060 後，你就可以看到本地文檔瀏覽伺服器提供的頁面。