GO 語言注釋
Go語言的注釋主要分成兩類,分別是單行注釋和多行注釋。
單行注釋簡稱行注釋,是最常見的注釋形式,可以在任何地方使用以//開頭的單行注釋;多行注釋簡稱塊注釋,以/開頭,並以/結尾,且不可以嵌套使用,多行注釋一般用於包的文檔描述或注釋成塊的代碼片段。
在 package 語句之前的注釋內容將被默認認為是這個包的文檔說明。
對於代碼中的變量、常量、函數等對象最好也都加上對應的注釋,這樣有利於后期對代碼進行維護
godoc 工具
godoc 工具會從 Go 程序和包文件中提取頂級聲明的首行注釋以及每個對象的相關注釋,並生成相關文檔,也可以作為一個提供在線文檔瀏覽的 web 服務器,Go語言官網(https://golang.google.cn/)但是Go語言 1.13 版本移除了 godoc 工具,大家可以通過命令來獲取 godoc 工具。由於防火牆的原因,國內的用戶可能無法通過命令來獲取 godoc 工具,這時候就需要大家來手動操作了。
go doc

godoc 工具還可以獲取 Go 安裝目錄下 ../go/src 中的注釋內容,並將這些注釋內容整合到 web 服務器中供我們預覽。在命令行輸入,然后使用瀏覽器打開 http://localhost:6060 后,就可以看到本地文檔瀏覽服務器提供的頁面。
