go語言如何注釋

go語言注釋的方法：1、通過將“//”符號放在單行go語句前面來實現單行注釋；2、通過“/*…*/”符號包圍需要注釋掉的go代碼段來實現多行注釋。

本文環境：Windows7系統、Go1.11.2版，本文適用于所有品牌的電腦。

推薦：《go語言教程》

注釋在程序中的作用是對程序進行注解和說明，便于對源碼的閱讀。編譯系統在對源代碼進行編譯時會自動忽略注釋的部分，因此注釋對于程序的功能實現不起任何作用。在源碼中適當地添加注釋，能夠提高源碼的可讀性。

Go語言的注釋主要分成兩類，分別是單行注釋和多行注釋。

單行注釋簡稱行注釋，是最常見的注釋形式，可以在任何地方使用以//開頭的單行注釋；

多行注釋簡稱塊注釋，以/*開頭，并以*/結尾，且不可以嵌套使用，多行注釋一般用于包的文檔描述或注釋成塊的代碼片段。

單行注釋的格式如下所示

//單行注釋

多行注釋的格式如下所示

/* 第一行注釋 第二行注釋 ... */

每一個包都應該有相關注釋，在使用 package 語句聲明包名之前添加相應的注釋，用來對包的功能及作用進行簡要說明。

同時，在 package 語句之前的注釋內容將被默認認為是這個包的文檔說明。一個包可以分散在多個文件中，但是只需要對其中一個進行注釋說明即可。

在多段注釋之間可以使用空行分隔加以區分，如下所示：

// 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

對于代碼中的變量、常量、函數等對象最好也都加上對應的注釋，這樣有利于后期對代碼進行維護，例如下面代碼中對 enterOrbit 函數的注釋：

// enterOrbit causes Superman to fly into low Earth orbit, a position // that presents several possibilities for planet salvation. func enterOrbit() error {    ... }

當開發人員需要了解包的一些情況時，可以使用 godoc 來顯示包的文檔說明