二 golang推薦的命名規范

很少見人總結一些命名規范，也可能是筆者孤陋寡聞， 作為一個兩年的golang 開發者， 我根據很多知名的項目，如 moby, kubernetess 等總結了一些常見的命名規范。
命名規范可以使得代碼更容易(yi)與(yu)閱(yue)讀， 更少的(de)出現錯誤(wu)。

文件命名規范
由(you)于文(wen)件跟包無任何關系， 而又避免windows大小寫的問題，所以(yi)推(tui)薦(jian)的明(ming)明(ming)規(gui)范(fan)如下(xia)：

• 文件名應一律使用小寫
• 不同單詞之間用下劃線分割
• 命名應盡可能地見名知意

常量命名規范
常量明(ming)明(ming)用 camelcase來命名示(shi)例如(ru)下

const todayNews = "Hello"

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

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

變量命名規范
與常量(liang)命名(ming)(ming)方式一(yi)樣，變量(liang)也(ye)應該使(shi)用駝峰的(de)命名(ming)(ming)方式, 但(dan)注意(yi)盡量(liang)不與包名(ming)(ming)一(yi)致或者以包名(ming)(ming)開頭

var x string
x := new(string)

函數命名規范
由(you)于(yu)Golang的特(te)殊性(xing)(xing)（用大小寫來控(kong)制函數的可見性(xing)(xing)），除特(te)殊的性(xing)(xing)能測試與單元測試函數之外, 都應該遵循如下(xia)原則(ze)

• 使用駝峰命名
• 如果包外不需要訪問請用小寫開頭的函數
• 如果需要暴露出去給包外訪問需要使用大寫開頭的函數名稱
  一個典型的函數命名方法如下：

// 注釋一律使用雙斜線， 對象暴露的方法
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, ""))
}

接口命名規范
接(jie)口命名也是要遵循駝峰方式命名， 可以用(yong) type alias 來定義大寫(xie)開頭的type 給(gei)包外訪問

type helloWorld interface {
func Hello();
}

type SayHello helloWorld

Struct命名規范

• 與接口命名規范類似

receiver 命名規范
golang 中存在receiver 的(de)概念(nian) receiver 名稱應該(gai)盡量保持(chi)一致， 避免(mian)this, super，等(deng)其他語言(yan)的(de)一些語義(yi)關鍵字如下

type A struct{}

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

注釋規范

• 注釋應一律使用雙斜線