Golang 推薦的命名規範

不多見人總結一些命名規範，也多是筆者孤陋寡聞， 做爲一個兩年的golang 開發者， 我根據不少知名的項目，如 moby, kubernetess 等總結了一些常見的命名規範。 命名規範可使得代碼更容易與閱讀， 更少的出現錯誤。

若有不一樣意見歡迎吐槽、討論。 項目地址

文件命名規範

因爲文件跟包無任何關係， 而又避免windows大小寫的問題，因此推薦的明明規範以下： 文件名應一概使用小寫， 不一樣單詞之間用下劃線分割, 命名應儘量地見名知意

常量命名規範

常量明明用 camelcase來命名示例以下

const todayNews = "Hello"
複製代碼

// 若是超過了一個常量應該用括號的方法來組織

const (
   systemName = "What"
   sysVal = "dasdsada"
)
複製代碼

變量命名規範

與常量命名方式同樣，變量也應該使用駝峯的命名方式, 但注意儘可能不與包名一致或者以包名開頭

var  x string
x := new(string)
複製代碼

函數命名規範

因爲Golang的特殊性（用大小寫來控制函數的可見性），除特殊的性能測試與單元測試函數以外, 都應該遵循以下原則

1. 使用駝峯命名
2. 若是包外不須要訪問請用小寫開頭的函數
3. 若是須要暴露出去給包外訪問須要使用大寫開頭的函數名稱

一個典型的函數命名方法以下：

// 註釋一概使用雙斜線， 對象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
   result := db.NewRecord(*file)
   if result {
      db.Create(file)
   }
   return result
}
 
// 不須要給包外訪問的函數以下
func removeCommaAndQuote(content string) string {
   re, _ := regexp.Compile("[\\`\\,]+")
   return strings.TrimSpace(re.ReplaceAllString(content, ""))
}
複製代碼

接口命名規範

接口命名也是要遵循駝峯方式命名， 能夠用 type alias 來定義大寫開頭的type 給包外訪問

type helloWorld interface {
    func Hello(); } type SayHello helloWorld 複製代碼

Struct命名規範

與接口命名規範相似

receiver 命名規範

golang 中存在receiver 的概念 receiver 名稱應該儘可能保持一致， 避免this, super，等其餘語言的一些語義關鍵字以下

type A struct{}

func (a *A) methodA() {
}
func (a *A) methodB() {
    a.methodA()
}
複製代碼

註釋規範

註釋應一概使用雙斜線

其餘

格式化， 用tab不是空格， 能夠與go fmt 兼容