我一直在研究 godoc，發現“go doc”更適合從命令行提供使用幫助，例如：go doc -cmd -u列出包注釋和任何函數（或其他實體）go doc *function*然后顯示單個功能（或其他實體）的文檔似乎有一個相關的工具叫做godoc。godoc 似乎也在每個包和函數的基礎上生成 html。例如godoc -html hello生成僅包含包注釋的 html 到標準輸出godoc是一個非常令人困惑的名字，因為我們也有go doc ！如何為整個項目創建靜態文檔？這類似于Godoc，為整個包創建 html，這可能被誤解為詢問包的文檔而不是項目。我想要一個可以在原則上可能包含許多包和應用程序的項目中使用的構建步驟。
4 回答
斯蒂芬大帝
TA貢獻1827條經驗 獲得超8個贊
即使使用 godoc，是否有一種規范的方法來生成供離線使用的文檔？
Go 1.12（2019 年 2 月）對此更清楚：
godoc和go doc在 Go 1.12 中，
godoc不再有命令行界面，只是一個 Web 服務器。
用戶應該改用go doc命令行幫助輸出。
go doc現在支持-allflag，這將導致它打印所有導出的 API 及其文檔，就像以前的godoc命令行一樣。
cmd/doc: 添加-all標志以打印包的所有文檔與舊的不同
godoc，您需要-u標志才能看到未導出的符號。
這似乎是正確的行為：它是一致的。
交互式愛情
TA貢獻1712條經驗 獲得超3個贊
我一直在努力做到這一點，最后，對我有用的是
確保你安裝了“wget”（我使用的是 mac，所以必須使用 x-code 安裝它）
以 root 用戶身份登錄并修改名為“robots.txt”的文件以刪除“Disallow : /”行，因為這會阻止 wget 遞歸下載站點。“robots.txt”文件應該在 $GOROOT 路徑中。
打開 cmd 并使用以下命令啟動 godocs 服務器
godoc -http=:6060
我將我的本地路徑配置到這個端口。
打開另一個 cmd 并運行以下命令。
wget -r -np -N -E -p -k http://localhost:6060/pkg/myproject
您可以提及項目的路徑，以便為整個項目下載 html 文檔。
慕蓋茨4494581
TA貢獻1850條經驗 獲得超11個贊
您可以嘗試Golds，這是一個備用的 Go 文檔生成工具（和一個本地文檔服務器/代碼閱讀器）。
在您的項目目錄下，您可以運行以下任何命令為您的 Go 項目生成 HTML 文檔：
golds -gen -nouses -plainsrc -wdpkgs-listing=promoted ./...
golds -gen -nouses -wdpkgs-listing=promoted ./...
golds -gen -wdpkgs-listing=提升./...
第一個命令生成最緊湊的文檔，最后一個命令生成完整文檔，其大小是緊湊文檔的 6 倍。
慕桂英4014372
TA貢獻1871條經驗 獲得超13個贊
這也可以使用簡單的wget命令來實現。
我對此有類似的問題。我正在為我的項目使用 GitLab，我決定為 Go 項目創建并共享一些方便的 GitLab CI YAML 模板，這些模板將自動生成靜態 HTML Go 文檔，無需任何外部包：https:?//gitlab.com/tymonx/ gitlab-ci
示例：Go Logger 文檔
兩個不錯的功能：
嵌入式 Go 源代碼文件
搜索框引用了 GitLab
- 4 回答
- 0 關注
- 200 瀏覽
添加回答
舉報
0/150
提交
取消