Golang 推薦的命名規範

winjeg發表於2019-02-19
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 相容

相關文章