Golang 推薦的命名規(guī)范

很少見(jiàn)人總結(jié)一些命名規(guī)范，也可能是筆者孤陋寡聞， 作為一個(gè)兩年的golang 開(kāi)發(fā)者， 我根據(jù)很多知名的項(xiàng)目，如 moby, kubernetess 等總結(jié)了一些常見(jiàn)的命名規(guī)范。 命名規(guī)范可以使得代碼更容易與閱讀， 更少的出現(xiàn)錯(cuò)誤。

如有不同意見(jiàn)歡迎吐槽、討論。 項(xiàng)目地址

文件命名規(guī)范

由于文件跟包無(wú)任何關(guān)系， 而又避免windows大小寫(xiě)的問(wèn)題，所以推薦的明明規(guī)范如下： 文件名應(yīng)一律使用小寫(xiě)， 不同單詞之間用下劃線分割, 命名應(yīng)盡可能地見(jiàn)名知意

常量命名規(guī)范

常量明明用 camelcase來(lái)命名示例如下

const todayNews = "Hello"

// 如果超過(guò)了一個(gè)常量應(yīng)該用括號(hào)的方法來(lái)組織

const (
  systemName = "What"
  sysVal = "dasdsada"
)

變量命名規(guī)范

與常量命名方式一樣，變量也應(yīng)該使用駝峰的命名方式, 但注意盡量不與包名一致或者以包名開(kāi)頭

var x string
x := new(string)

函數(shù)命名規(guī)范

由于Golang的特殊性（用大小寫(xiě)來(lái)控制函數(shù)的可見(jiàn)性），除特殊的性能測(cè)試與單元測(cè)試函數(shù)之外, 都應(yīng)該遵循如下原則

1. 使用駝峰命名
2. 如果包外不需要訪問(wèn)請(qǐng)用小寫(xiě)開(kāi)頭的函數(shù)
3. 如果需要暴露出去給包外訪問(wèn)需要使用大寫(xiě)開(kāi)頭的函數(shù)名稱

一個(gè)典型的函數(shù)命名方法如下：

// 注釋一律使用雙斜線， 對(duì)象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
  result := db.NewRecord(*file)
  if result {
   db.Create(file)
  }
  return result
}
 
// 不需要給包外訪問(wèn)的函數(shù)如下
func removeCommaAndQuote(content string) string {
  re, _ := regexp.Compile("[\\`\\,]+")
  return strings.TrimSpace(re.ReplaceAllString(content, ""))
}

接口命名規(guī)范

接口命名也是要遵循駝峰方式命名， 可以用 type alias 來(lái)定義大寫(xiě)開(kāi)頭的type 給包外訪問(wèn)

type helloWorld interface {
  func Hello();
}

type SayHello helloWorld

Struct命名規(guī)范

與接口命名規(guī)范類似

receiver 命名規(guī)范

golang 中存在receiver 的概念 receiver 名稱應(yīng)該盡量保持一致， 避免this, super，等其他語(yǔ)言的一些語(yǔ)義關(guān)鍵字如下

type A struct{}

func (a *A) methodA() {
}
func (a *A) methodB() {
  a.methodA()
}

注釋規(guī)范

注釋?xiě)?yīng)一律使用雙斜線

其他

格式化， 用tab不是空格， 可以與go fmt 兼容

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。