建站
咨詢
售后
建站咨詢
新聞中心
注釋在程序中的作用是對(duì)程序進(jìn)行注解和說明，便于對(duì)源碼的閱讀。編譯系統(tǒng)在對(duì)源代碼進(jìn)行編譯時(shí)會(huì)自動(dòng)忽略注釋的部分，因此注釋對(duì)于程序的功能實(shí)現(xiàn)不起任何作用。在源碼中適當(dāng)?shù)靥砑幼⑨?，能夠提高源碼的可讀性。
公司主營(yíng)業(yè)務(wù)：網(wǎng)站制作、成都網(wǎng)站建設(shè)、移動(dòng)網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實(shí)現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競(jìng)爭(zhēng)能力。創(chuàng)新互聯(lián)公司是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊(duì)。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對(duì)我們的高要求，感謝他們從不同領(lǐng)域給我們帶來(lái)的挑戰(zhàn)，讓我們激情的團(tuán)隊(duì)有機(jī)會(huì)用頭腦與智慧不斷的給客戶帶來(lái)驚喜。創(chuàng)新互聯(lián)公司推出松北免費(fèi)做網(wǎng)站回饋大家。
Go語(yǔ)言的注釋主要分成兩類，分別是單行注釋和多行注釋。
- 單行注釋簡(jiǎn)稱行注釋，是最常見的注釋形式，可以在任何地方使用以
//開頭的單行注釋； - 多行注釋簡(jiǎn)稱塊注釋，以
/*開頭，并以*/結(jié)尾，且不可以嵌套使用，多行注釋一般用于包的文檔描述或注釋成塊的代碼片段。
單行注釋的格式如下所示
//單行注釋
多行注釋的格式如下所示
/*
第一行注釋
第二行注釋
...
*/
每一個(gè)包都應(yīng)該有相關(guān)注釋，在使用 package 語(yǔ)句聲明包名之前添加相應(yīng)的注釋，用來(lái)對(duì)包的功能及作用進(jìn)行簡(jiǎn)要說明。
同時(shí)，在 package 語(yǔ)句之前的注釋內(nèi)容將被默認(rèn)認(rèn)為是這個(gè)包的文檔說明。一個(gè)包可以分散在多個(gè)文件中，但是只需要對(duì)其中一個(gè)進(jìn)行注釋說明即可。
在多段注釋之間可以使用空行分隔加以區(qū)分，如下所示：
// Package superman implements methods for saving the world. // // Experience has shown that a small number of procedures can prove // helpful when attempting to save the world. package superman
對(duì)于代碼中的變量、常量、函數(shù)等對(duì)象最好也都加上對(duì)應(yīng)的注釋，這樣有利于后期對(duì)代碼進(jìn)行維護(hù)，例如下面代碼中對(duì)
enterOrbit 函數(shù)的注釋：
// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
...
}當(dāng)開發(fā)人員需要了解包的一些情況時(shí)，可以使用 godoc 來(lái)顯示包的文檔說明，下面來(lái)介紹一下 godoc 工具的使用。
godoc 工具
godoc 工具會(huì)從 Go 程序和包文件中提取頂級(jí)聲明的首行注釋以及每個(gè)對(duì)象的相關(guān)注釋，并生成相關(guān)文檔，也可以作為一個(gè)提供在線文檔瀏覽的 web 服務(wù)器，Go語(yǔ)言官網(wǎng)（ https://golang.google.cn/）就是通過這種形式實(shí)現(xiàn)的。
但是Go語(yǔ)言 1.13 版本移除了 godoc 工具，大家可以通過
go get 命令來(lái)獲取 godoc 工具。
go get golang.org/x/tools/cmd/godoc
由于防火墻的原因，國(guó)內(nèi)的用戶可能無(wú)法通過
go get 命令來(lái)獲取 godoc 工具，這時(shí)候就需要大家來(lái)手動(dòng)操作了。
- 首先從 GitHub（https://github.com/golang/tools.git） 下載 golang.org/x/tools 包；
- 然后將下載得到的文件解壓到 GOPATH 下的 src\golang.org\x\tools 目錄中，沒有的話可以手動(dòng)創(chuàng)建；
- 打開 GOPATH 下的 src\golang.org\x\tools\cmd\godoc 目錄，在該目錄下打開命令行工具，并執(zhí)行
go build命令，生成 godoc.exe 可執(zhí)行文件； - 最后，將生成的 godoc.exe 文件移動(dòng)到 GOPATH 下的 bin 目錄中。（需要把 GOPATH 下的 bin 目錄添加到環(huán)境變量 Path 中）
完成上述操作后就可以使用 godoc 工具了，godoc 工具一般有以下幾種用法：
- go doc package：獲取包的文檔注釋，例如
go doc fmt會(huì)顯示使用 godoc 生成的 fmt 包的文檔注釋； - go doc package/subpackage：獲取子包的文檔注釋，例如
go doc container/list； - go doc package function：獲取某個(gè)函數(shù)在某個(gè)包中的文檔注釋，例如
go doc fmt Printf會(huì)顯示有關(guān) fmt.Printf() 的使用說明。
下圖演示了使用
go doc 命令來(lái)獲取包的文檔注釋：
godoc 工具還可以獲取 Go 安裝目錄下 ../go/src 中的注釋內(nèi)容，并將這些注釋內(nèi)容整合到 web 服務(wù)器中供我們預(yù)覽。在命令行輸入
godoc -http=:6060，然后使用瀏覽器打開 http://localhost:6060 后，就可以看到本地文檔瀏覽服務(wù)器提供的頁(yè)面。
文章名稱：創(chuàng)新互聯(lián)GO教程:Go語(yǔ)言注釋的定義及使用（godoc工具提取注釋內(nèi)容）
URL分享：http://fisionsoft.com.cn/article/cojiods.html
