詳解Golang 推薦的命名規(guī)范
Golang 推薦的命名規(guī)范
很少見人總結(jié)一些命名規(guī)范，也可能是筆者孤陋寡聞， 作為一個兩年的golang 開發(fā)者， 我根據(jù)很多知名的項目，如 moby, kubernetess 等總結(jié)了一些常見的命名規(guī)范。 命名規(guī)范可以使得代碼更容易與閱讀， 更少的出現(xiàn)錯誤。
如有不同意見歡迎吐槽、討論。 項目地址
文件命名規(guī)范
由于文件跟包無任何關(guān)系， 而又避免windows大小寫的問題，所以推薦的明明規(guī)范如下： 文件名應(yīng)一律使用小寫， 不同單詞之間用下劃線分割, 命名應(yīng)盡可能地見名知意
常量命名規(guī)范
常量明明用 camelcase來命名示例如下
const todayNews = "Hello" // 如果超過了一個常量應(yīng)該用括號的方法來組織 const ( systemName = "What" sysVal = "dasdsada" )
變量命名規(guī)范
與常量命名方式一樣，變量也應(yīng)該使用駝峰的命名方式, 但注意盡量不與包名一致或者以包名開頭
var x string x := new(string)
函數(shù)命名規(guī)范
由于Golang的特殊性（用大小寫來控制函數(shù)的可見性），除特殊的性能測試與單元測試函數(shù)之外, 都應(yīng)該遵循如下原則
- 使用駝峰命名
- 如果包外不需要訪問請用小寫開頭的函數(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 名稱應(yīng)該盡量保持一致， 避免this, super，等其他語言的一些語義關(guān)鍵字如下
type A struct{}
func (a *A) methodA() {
}
func (a *A) methodB() {
a.methodA()
}
注釋規(guī)范
注釋應(yīng)一律使用雙斜線
其他
格式化， 用tab不是空格， 可以與go fmt 兼容
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
在Go語言中,類型推斷可以根據(jù)變量的初始化值自動推斷出變量的類型,而不需要顯式地聲明變量類型,變量重聲明可以在同一作用域內(nèi)重復(fù)聲明一個變量,只要其中至少一個是新的變量,本就簡單的給大家介紹一下golang類型推斷和變量重聲明,需要的朋友可以參考下2023-08-08
最近有遇到需要用go讀取文件的情況,下面這篇文章主要給大家介紹了關(guān)于go按行讀取文件的三種實現(xiàn)方式,文中通過實例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-09-09
基于go中fyne gui的通達(dá)信數(shù)據(jù)導(dǎo)出工具詳解
這篇文章主要介紹了基于go中fyne gui的通達(dá)信數(shù)據(jù)導(dǎo)出工具,這是一個用 Go 語言開發(fā)的通達(dá)信數(shù)據(jù)導(dǎo)出工具,可以將通達(dá)信的本地數(shù)據(jù)導(dǎo)出為多種格式,方便用戶進(jìn)行數(shù)據(jù)分析和處理,需要的朋友可以參考下2024-12-12
這篇文章主要介紹了Go語言錯誤處理異常捕獲和異常拋出，Go語言的作者認(rèn)為java等語言的錯誤處理底層實現(xiàn)較為復(fù)雜,就實現(xiàn)了函數(shù)可以返回錯誤類型以及簡單的異常捕獲,雖然簡單但是也非常精妙,大大的提高了運(yùn)行效率,下文需要的朋友可以參考一下2022-02-02
結(jié)構(gòu)體是Go語言中重要且靈活的概念之一，本文旨在深入介紹Go語言中的結(jié)構(gòu)體，揭示其重要性和靈活性，并向讀者展示結(jié)構(gòu)體支持的眾多特性，需要的可以參考一下2023-06-06
go mod更新指定的tag的包后,go vendor內(nèi)容未更新問題
這篇文章主要介紹了go mod更新指定的tag的包后,go vendor內(nèi)容未更新問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-09-09
Mac下Vs code配置Go語言環(huán)境的詳細(xì)過程
這篇文章給大家介紹Mac下Vs code配置Go語言環(huán)境的詳細(xì)過程，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友參考下吧2021-07-07
這篇文章主要和大家分享一下Go語言中的函數(shù)的使用，文中的示例代碼講解詳細(xì)，對我們學(xué)習(xí)Go語言有一定的幫助，需要的小伙伴可以參考一下2022-11-11
詳解Go語言如何對數(shù)據(jù)庫進(jìn)行CRUD操作
在這篇文章中，主要帶大家來學(xué)習(xí)一下在Go語言中如何對數(shù)據(jù)庫進(jìn)行CRUD操作，從而探討一下Go的接口編程，感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-05-05