godoc工具(第 3.6 節(jié))在顯示自定義包中的注釋也有很好的效果:注釋必須以 // 開始并無空行放在聲明(包,類型,函數(shù))前。godoc 會為每個文件生成一系列的網(wǎng)頁。
例如:
命令行下進(jìn)入目錄下并輸入命令:
godoc -http=:6060 -goroot="."
(. 是指當(dāng)前目錄,-goroot 參數(shù)可以是 /path/to/my/package1 這樣的形式指出 package1 在你源碼中的位置或接受用冒號形式分隔的路徑,無根目錄的路徑為相對于當(dāng)前目錄的相對路徑)
然后你會看到本地的 godoc 頁面(詳見第 3.6 節(jié))從左到右一次顯示出目錄中的包:
doc_example:
doc_example | Packages | Commands | Specification
下面是鏈接到源碼和所有對象時有序概述(所以是很好的瀏覽和查找源代碼的方式),連同文件/注釋:
sort 包
func Float64sAreSorted
type IntArray
func IntsAreSortedfunc IsSortedfunc Sort
func (IntArray) Len
func SortFloat64s
func (IntArray) Less
func SortInts
func (IntArray) Swap
func SortStrings type Interface
func StringsAreSorted type StringArray type Float64Array
func (StringArray) Len
func (Float64Array) Len
func (StringArray) Less
func (Float64Array) Less
func (StringArray) Swap
func (Float64Array) Swap
// Other packages
import "doc_example"
使用通用的接口排序:
func Float64sAreSorted[Top]
func Float64sAreSorted(a []float64) bool
func IntsAreSorted[Top]
func IntsAreSorted(a []int) bool
func IsSorted[Top]
func IsSorted(data Interface) bool
Test if data is sorted
func Sort[Top]
func Sort(data Interface)
General sort function
func SortInts[Top]
func SortInts(a []int)
Convenience wrappers for common cases: type IntArray[Top]
Convenience types for common cases: IntArray type IntArray []int
如果你在一個團(tuán)隊中工作,并且源代碼樹被存儲在網(wǎng)絡(luò)硬盤上,就可以使用 godoc 給所有團(tuán)隊成員連續(xù)文檔的支持。通過設(shè)置 sync_minutes=n,你甚至可以讓它每 n 分鐘自動更新您的文檔!