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
return result}
// 不需要給包外訪問的函式如下
func removecommaandquote(content string) string
介面命名規範
介面命名也是要遵循駝峰方式命名, 可以用 type alias 來定義大寫開頭的type 給包外訪問
type helloworld inte***ce
type sayhello helloworld
struct命名規範
與介面命名規範類似
receiver 程式設計客棧命名規範
golang 中存在receiver 的概念 receiver 名稱應該盡量保持一致, 避免this, super,等其他語言的一些語義關鍵字如下
type a struct{}
func (a *a) methoda()
func (a *a) methodb()
注釋規範
注釋應一律使用雙斜線
其他格式化, 用tab不是空格, 可以與go fmt 相容程式設計客棧
本文位址:
PCL推薦的命名規範 2
部落格 自 函式和類的成員函式的命名應該採用camelcased,也就是連寫單詞組成命名,除了首個單詞首字母小寫其他單詞首字母大寫,它們的引數命名單詞之間用下劃線隔開,函式和類的成員函式命名最好採用動詞,應該確保這些名字能清楚的表達函式和類成員函式的功能,例如 checkforerrors 而不是e...
C 程式變數命名推薦規範
變數的規範命名是為了增強 的可讀性和容易維護性。c 程式變數命名只有幾條必須遵守的 死規則 這些規則如下 1 變數名只能是字母 a z,a z 數字 0 9 或下畫線。2 第乙個字母不能是數字,例如2lerver 這不是乙個合法的c 變數。3 不能是c 關鍵字,例如不能用class 這個單詞來命名乙...
Python之父Guido推薦命名規範
1.模組名和包名採用小寫字母並且以下劃線分隔單詞的形式 如 regex syntax,py compile,winreg 2.類名或異常名採用每個單詞首字母大寫的方式 如 baseserver,forkingmixin,keyboardinterrupt 3.全域性或者類常量,全部使用大寫字母,並且...