2012-11-23 128 views
40

我寫了一個小程序,我想從源代碼生成獨立的HTML文檔,可以在沒有godoc服務器的情況下查看。但我找不到任何方法來實現它。如果有人能幫助我,我會感激。如何使用`godoc`生成HTML文檔?

回答

29

一個簡單的HTML文檔可通過如下方法制造,例如:

$ godoc -url "http://localhost:6060/pkg/container/heap/" > page.html 

(我godoc服務器運行的::6060和我

$ godoc -html container/heap Interface > page.html 

的位更好的形式可以通過用產生的我不確定這是否是先決條件)。

通過調整生成的HTML文件以正確引用它,如果將其與Go存儲庫中找到的原始CSS樣式相結合,HTML可能會更好看。

+1

沒有必要爲一個真正的服務器和'godoc -url「/包裝/容器/堆/」> page.html'就足夠 – FiloSottile

+0

有一個變更請求開放添加生成靜態網站的支持https://github.com/golang/go/issues/2381#issuecomment-342043987 – dnephin

11

這可能不會直接回答你的問題,但如果你打算開源你的項目,你並不需要手動生成HTML。只要確保您的註釋已正確插入源代碼中,並使用godoc.org(http://godoc.org/-/about)來處理它。

它顯示Go包在Bitbucket,Github,Launchpad和Google Project Hosting上的文檔。

檢查了這一點,例如:http://godoc.org/code.google.com/p/go.crypto/ssh

+1

謝謝,當我在Godoc上找到我的軟件包文檔時,我感到很驚訝! – pltvs