go 程式設計規範

參考

go 語言程式設計規範

大部分的格式問題可以通過 gofmt 來解決，gofmt 自動格式化**，保證所有的 go **與官方推薦的格式保持一致，所有格式有關問題，都以gofmt的結果為準。所以，建議在提交**庫之前先執行一下這個命令。

一行最長不超過80個字元，超過的使用換行展示，盡量保持格式優雅。

在編碼階段應該同步寫好變數、函式、包的注釋，最後可以利用 godoc 命令匯出文件。注釋必須是完整的句子，句子的結尾應該用句號作為結尾（英文句號）。注釋推薦用英文，可以在寫**過程中鍛鍊英文的閱讀和書寫能力。而且用英文不會出現各種編碼的問題。

每個包都應該有乙個包注釋，乙個位於 package 子句之前的塊注釋或行注釋。包如果有多個 go 檔案，只需要出現在乙個 go 檔案中即可。

//
ping包實現了常用的ping相關的函式
package ping

type reader inte***ce

//多個函式介面

type writeflusher inte***ce

常量均需使用全部大寫字母組成，並使用下劃線分詞：

1.0"

如果是列舉型別的常量，需要先建立相應型別：

變數命名基本上遵循相應的英文表達或簡寫，在相對簡單的環境（物件數量少、針對性強）中，可以將一些名稱由完整單詞簡寫為單個字母，例如：

var i***ist bool
var hasconflict bool
var canmanage bool
var allowgithook bool

變數名稱一般遵循駝峰法，但遇到特有名詞時，需要遵循以下規則：

下面列舉了一些常見的特有名詞：

struct申明和初始化格式採用多行，定義如下：

type user struct

初始化如下：

u :=user

盡量不要使用panic，除非你知道你在做什麼

對 import 的包進行分組管理，用換行符分割，而且標準庫作為分組的第一組。如果你的包引入了三種型別的包，標準庫包，程式內部包，第三方包，建議採用如下方式進行組織你的包

")goimports 會自動幫你格式化

單元測試檔名命名規範：

example_test.go

測試用例的函式名稱必須以 test 開頭，例如：

func testexample