Golang 推薦的命名規(guī)范
很少見人總結一些命名規(guī)范，也可能是筆者孤陋寡聞， 作為一個兩年的golang 開發(fā)者， 我根據(jù)很多知名的項目，如 moby, kubernetess 等總結了一些常見的命名規(guī)范。 命名規(guī)范可以使得代碼更容易與閱讀， 更少的出現(xiàn)錯誤。
如有不同意見歡迎吐槽、討論。 項目地址
文件命名規(guī)范
由于文件跟包無任何關系， 而又避免windows大小寫的問題，所以推薦的明明規(guī)范如下： 文件名應一律使用小寫， 不同單詞之間用下劃線分割, 命名應盡可能地見名知意
常量命名規(guī)范
常量明明用 camelcase來命名示例如下
const todayNews = "Hello"
// 如果超過了一個常量應該用括號的方法來組織
const (
systemName = "What"
sysVal = "dasdsada"
)
變量命名規(guī)范
與常量命名方式一樣，變量也應該使用駝峰的命名方式, 但注意盡量不與包名一致或者以包名開頭
var x string
x := new(string)
函數(shù)命名規(guī)范
由于Golang的特殊性（用大小寫來控制函數(shù)的可見性），除特殊的性能測試與單元測試函數(shù)之外, 都應該遵循如下原則
- 使用駝峰命名
- 如果包外不需要訪問請用小寫開頭的函數(shù)
- 如果需要暴露出去給包外訪問需要使用大寫開頭的函數(shù)名稱
一個典型的函數(shù)命名方法如下：
// 注釋一律使用雙斜線， 對象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
result := db.NewRecord(*file)
if result {
db.Create(file)
}
return result
}
// 不需要給包外訪問的函數(shù)如下
func removeCommaAndQuote(content string) string {
re, _ := regexp.Compile("[\\`\\,]+")
return strings.TrimSpace(re.ReplaceAllString(content, ""))
}
接口命名規(guī)范
接口命名也是要遵循駝峰方式命名， 可以用 type alias 來定義大寫開頭的type 給包外訪問
type helloWorld interface {
func Hello();
}
type SayHello helloWorld
Struct命名規(guī)范
與接口命名規(guī)范類似
receiver 命名規(guī)范
golang 中存在receiver 的概念 receiver 名稱應該盡量保持一致， 避免this, super，等其他語言的一些語義關鍵字如下
type A struct{}
func (a *A) methodA() {
}
func (a *A) methodB() {
a.methodA()
}
注釋規(guī)范
注釋應一律使用雙斜線
其他
格式化， 用tab不是空格， 可以與go fmt 兼容
以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
