您好,登錄后才能下訂單哦!
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() }
注釋規范
注釋應一律使用雙斜線
其他
格式化, 用tab不是空格, 可以與go fmt 兼容
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持億速云。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。