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 來顯示套件的文件說明

#更多相關技術文章，請造訪golang教學欄位！

以上是go語言如何註釋的詳細內容。更多資訊請關注PHP中文網其他相關文章！