我正在使用 godocs 來記錄我用 go/golang 編寫的 API，并且我正在使用 godocs 來記錄它，因為我生成了整個 main.go 文件的 HTML 頁面，其中包含用于創(chuàng)建我的 API 的所有函數(shù)。但是，我不想顯示有關(guān)我的所有輔助函數(shù)的信息，我只想顯示有關(guān)文件中某些函數(shù)的標(biāo)題信息。有沒有辦法只允許文件中的一些函數(shù)成為文檔的一部分，或者我必須為我的所有幫助函數(shù)創(chuàng)建另一個文件？現(xiàn)在我正在本地端口 8000 上對其進(jìn)行測試：godoc -http=:8000
1 回答
達(dá)令說
TA貢獻(xiàn)1821條經(jīng)驗 獲得超6個贊
godoc及其近親go doc命令的默認(rèn)行為顯示導(dǎo)出聲明的包文檔。奇怪的是，我沒有找到一個簡單的權(quán)威來源來鏈接到明確記錄這一事實，但是在改變默認(rèn)行為的命令中引用了該事實的推斷，例如來自godoc 包的文檔：
godoc服務(wù)的網(wǎng)頁的展示方式可以通過“m”URL參數(shù)來控制；它接受以逗號分隔的標(biāo)志名稱列表作為值：
...
例如，http ://golang.org/pkg/math/big/?m=all,text 以文本形式顯示了 package big 的所有（不僅僅是導(dǎo)出的）聲明的文檔（使用 godoc 時會出現(xiàn)）從命令行：“godoc -src math/big .*”）。
https://golang.org/src/go/doc/doc.go的源代碼包括：
81 const (
82 // extract documentation for all package-level declarations,
83 // not just exported ones
84 AllDecls Mode = 1 << iota
...
89 )
并且https://golang.org/src/go/doc/exports.go記錄了一個函數(shù)：
241 // fileExports removes unexported declarations from src in place.
最后go doc -h在終端中運行會顯示一個標(biāo)志：
-u 顯示未導(dǎo)出的符號以及導(dǎo)出的符號。
- 1 回答
- 0 關(guān)注
- 192 瀏覽
添加回答
舉報
0/150
提交
取消