如何創(chuàng)建可見的 Go 文檔？這很容易為 go 中的任何函數(shù)創(chuàng)建文檔，如下所示：package main// documentation examplefunc DocumentedFunction() bool { return true}當我調(diào)用該函數(shù)時，我可以看到該文檔：我可以編寫可以從編輯器/IDE 中看到的包文檔嗎？我是否必須安裝其他工具才能實現(xiàn)包文檔的類似行為？
1 回答
慕標琳琳
TA貢獻1830條經(jīng)驗 獲得超9個贊
根據(jù)官方 Go 文檔和此鏈接，應該可以為整個包創(chuàng)建文檔，就像為函數(shù)創(chuàng)建文檔一樣：
要記錄一個函數(shù)、類型、常量、變量，甚至是一個完整的包，請在其聲明之前直接寫一個常規(guī)注釋，中間不要有空行。
例如：字符串包：
// Package strings implements simple functions to manipulate UTF-8 encoded strings.
//
// For information about UTF-8 strings in Go, see https://blog.golang.org/strings.
package strings
..
..
rest of the file
package因此，您基本上只需在關(guān)鍵字上方添加普通注釋即可。
- 1 回答
- 0 關(guān)注
- 83 瀏覽
添加回答
舉報
0/150
提交
取消