二 golang推薦的命名規範 很少見人總結一些命名規範，也可能是筆者孤陋寡聞， 作為一個兩年的golang 開發者， 我根據很多知名的項目，如 moby, kubernetess 等總結了一些常見的命名規範。 命名規範可以使得代碼更容易與閱讀， 更少的出現錯誤。 文件命名規範 由於文件跟包無任何關 ...
二 golang推薦的命名規範
很少見人總結一些命名規範，也可能是筆者孤陋寡聞， 作為一個兩年的golang 開發者， 我根據很多知名的項目，如 moby, kubernetess 等總結了一些常見的命名規範。
命名規範可以使得代碼更容易與閱讀， 更少的出現錯誤。
文件命名規範
由於文件跟包無任何關係， 而又避免windows大小寫的問題，所以推薦的明明規範如下：
- 文件名應一律使用小寫
- 不同單詞之間用下劃線分割
- 命名應儘可能地見名知意
常量命名規範
常量明明用 camelcase來命名示例如下
const todayNews = "Hello"
// 如果超過了一個常量應該用括弧的方法來組織
const (
systemName = "What"
sysVal = "dasdsada"
)
變數命名規範
與常量命名方式一樣，變數也應該使用駝峰的命名方式, 但註意儘量不與包名一致或者以包名開頭
var x string
x := new(string)
函數命名規範
由於Golang的特殊性（用大小寫來控制函數的可見性），除特殊的性能測試與單元測試函數之外, 都應該遵循如下原則
- 使用駝峰命名
- 如果
包外不需要訪問請用小寫開頭的函數 - 如果需要
暴露出去給包外訪問需要使用大寫開頭的函數名稱
一個典型的函數命名方法如下：
// 註釋一律使用雙斜線， 對象暴露的方法
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()
}
註釋規範
- 註釋應一律使用雙斜線
作者：倉儲大叔，張占嶺，
榮譽：微軟MVP
QQ：853066980
支付寶掃一掃，為大叔打賞!
