歡迎關(guān)注個人公眾號 DailyJobOps
這里提前祝大家 2022新年快樂~
原文連接 golang注釋和文檔說明及go doc/godoc說明
golang注釋
- 單行注釋
是最常見和使用的注釋方式，以 // 開頭位衩，其后面的內(nèi)容都是注釋箍邮。
可以是單獨的一行整葡，也可以是在某個語句的后面涤久。
比如：
package main
// 導入我們需要包尺迂，而且只導入需要的吸重，多余導入會引起編譯錯誤
import (
"fmt" // 這里也是單行注釋霞篡，跟在某個語句的后面
)
- 多行注釋
不常使用世蔗，一般用來做代碼塊的注釋 或者是 包的文檔型描述， 文檔型描述需要盡可能詳細說明包及其對外暴露的函數(shù)等污淋，有時候單行注釋使用不方便
比如：
package convert
import (
"strconv"
)
/*
* 這里是多行注釋，進行自定義包中對外函數(shù)的詳細描述
* 描述可以盡可能詳細寸爆，讓大家能讀懂其作用是什么
*/
func Convert(name string) (string) {
... ...
}
golang 文檔描述
在進行項目開發(fā)的時候礁鲁，代碼的注釋是必不可少的，但是對于go來說而昨，自定義包及其包中對外暴露的函數(shù)，添加額外的特殊說明歌憨，方便使用者快速了解使用。
這種特殊的說明就是文檔描述务嫡，書寫有要求規(guī)范
-
包描述
一般是在緊挨著
package關(guān)鍵字上面一行甲抖，描述以Package開頭，比如// Package convert is ... package convert
-
函數(shù)描述
函數(shù)描述是在
func SomeName()的緊挨著上面一行心铃， 一般建議以Function開頭准谚，比如// Function SomeName is uesd to ... func SomeName() { ... ... }
go doc 工具
go doc 命令是基于go命令的去扣。主要的作用是打印出go程序的文檔信息，就是我們上面的所講的文檔描述愉棱。
通過 go help sub-command 可以查看具體命令的用法，比如這里的go help doc
在實際使用中奔滑，不清楚第三方如何使用的時候，go doc 就非常有用朋其，比如字符串轉(zhuǎn)浮點型，
-
go doc strconv
直接后面跟 包 名稱梅猿，可以查看包中都有哪些對外暴露的方法氓辣、變量等
-
go doc strconv ParseFloat
后面跟 包名 加 對應(yīng)的方法名袱蚓、變量名等，可以查看具體的說明和用法
# go doc strconv ParseFloat package strconv // import "strconv" func ParseFloat(s string, bitSize int) (float64, error) ParseFloat converts the string s to a floating-point number with the precision specified by bitSize: 32 for float32, or 64 for float64. When bitSize=32, the result still has type float64, but it will be convertible to ... ...再比如(注意使用 package.method 或者 package method 都可以)
# go doc fmt.Sprintf package fmt // import "fmt" func Sprintf(format string, a ...interface{}) string Sprintf formats according to a format specifier and returns the resulting string. -
go doc 后面不添加任何參數(shù)
會打印當前目錄所代表的代碼包的文檔及當中的包級別程序?qū)嶓w的列表
go doc 參數(shù)說明
- -c 區(qū)分參數(shù)中字母的大小寫
- -u 同時會打印出
不可導出的程序?qū)嶓w爽撒，默認只打印可導出實體 （golang的能否被其他包調(diào)用的原則就是可導出入蛆，首字母大寫） - -cmd 同時打印出
main包中的可導出的程序?qū)嶓w - -short 沒有實體文檔用一行標識
godoc 和 go doc 傻傻分不清楚
godoc 和 go doc 很像硕勿，但是不一樣哦~
go doc是go的子命令，用于在命令行輸出相關(guān)實體的文檔說明
godoc 是通過在本地啟動一個web程序源武，通過瀏覽器來展示本地相關(guān)包的文檔信息，類似golang的在線文檔
godoc默認是沒有安裝的粱栖，可以通過如下命令進行安裝，默認是安裝到
GOBIN環(huán)境變量定義的目錄中
go get -v -u golang.org/x/tools/cmd/godoc
啟動本地web訪問在線文檔的方式
godoc -http=:8080
然后在瀏覽器輸入 http://localhost:8080 即可查看
