詳解Golang 推薦的命名規(guī)范
Golang 推薦的命名規(guī)范
很少見(jiàn)人總結(jié)一些命名規(guī)范，也可能是筆者孤陋寡聞， 作為一個(gè)兩年的golang 開(kāi)發(fā)者， 我根據(jù)很多知名的項(xiàng)目，如 moby, kubernetess 等總結(jié)了一些常見(jiàn)的命名規(guī)范。 命名規(guī)范可以使得代碼更容易與閱讀， 更少的出現(xiàn)錯(cuò)誤。
如有不同意見(jiàn)歡迎吐槽、討論。 項(xiàng)目地址
文件命名規(guī)范
由于文件跟包無(wú)任何關(guān)系， 而又避免windows大小寫(xiě)的問(wèn)題，所以推薦的明明規(guī)范如下： 文件名應(yīng)一律使用小寫(xiě)， 不同單詞之間用下劃線(xiàn)分割, 命名應(yīng)盡可能地見(jiàn)名知意
常量命名規(guī)范
常量明明用 camelcase來(lái)命名示例如下
const todayNews = "Hello" // 如果超過(guò)了一個(gè)常量應(yīng)該用括號(hào)的方法來(lái)組織 const ( systemName = "What" sysVal = "dasdsada" )
變量命名規(guī)范
與常量命名方式一樣，變量也應(yīng)該使用駝峰的命名方式, 但注意盡量不與包名一致或者以包名開(kāi)頭
var x string x := new(string)
函數(shù)命名規(guī)范
由于Golang的特殊性（用大小寫(xiě)來(lái)控制函數(shù)的可見(jiàn)性），除特殊的性能測(cè)試與單元測(cè)試函數(shù)之外, 都應(yīng)該遵循如下原則
- 使用駝峰命名
- 如果包外不需要訪(fǎng)問(wèn)請(qǐng)用小寫(xiě)開(kāi)頭的函數(shù)
- 如果需要暴露出去給包外訪(fǎng)問(wèn)需要使用大寫(xiě)開(kāi)頭的函數(shù)名稱(chēng)
一個(gè)典型的函數(shù)命名方法如下：
// 注釋一律使用雙斜線(xiàn)， 對(duì)象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
result := db.NewRecord(*file)
if result {
db.Create(file)
}
return result
}
// 不需要給包外訪(fǎng)問(wèn)的函數(shù)如下
func removeCommaAndQuote(content string) string {
re, _ := regexp.Compile("[\\`\\,]+")
return strings.TrimSpace(re.ReplaceAllString(content, ""))
}
接口命名規(guī)范
接口命名也是要遵循駝峰方式命名， 可以用 type alias 來(lái)定義大寫(xiě)開(kāi)頭的type 給包外訪(fǎng)問(wèn)
type helloWorld interface {
func Hello();
}
type SayHello helloWorld
Struct命名規(guī)范
與接口命名規(guī)范類(lèi)似
receiver 命名規(guī)范
golang 中存在receiver 的概念 receiver 名稱(chēng)應(yīng)該盡量保持一致， 避免this, super，等其他語(yǔ)言的一些語(yǔ)義關(guān)鍵字如下
type A struct{}
func (a *A) methodA() {
}
func (a *A) methodB() {
a.methodA()
}
注釋規(guī)范
注釋?xiě)?yīng)一律使用雙斜線(xiàn)
其他
格式化， 用tab不是空格， 可以與go fmt 兼容
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了go-cqhttp環(huán)境配置,包括go-cqhttp安裝及簡(jiǎn)單介紹，本文結(jié)合示例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-09-09
golang使用 gomodule 在公共測(cè)試環(huán)境管理go的依賴(lài)的實(shí)例詳解
這篇文章主要介紹了golang使用 gomodule 在公共測(cè)試環(huán)境管理go的依賴(lài)，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-11-11
淺析Go使用定時(shí)器時(shí)如何避免潛在的內(nèi)存泄漏陷阱
這篇文章來(lái)和大家一起探討一下Go?中如何高效使用?timer,特別是與select?一起使用時(shí),如何防止?jié)撛诘膬?nèi)存泄漏問(wèn)題,感興趣的可以了解下2024-01-01
Go語(yǔ)言中定時(shí)任務(wù)庫(kù)Cron使用方法介紹
cron的意思計(jì)劃任務(wù)，說(shuō)白了就是定時(shí)任務(wù)。我和系統(tǒng)約個(gè)時(shí)間，你在幾點(diǎn)幾分幾秒或者每隔幾分鐘跑一個(gè)任務(wù)(job)，今天通過(guò)本文給大家介紹下Go語(yǔ)言中定時(shí)任務(wù)庫(kù)Cron使用方法，感興趣的朋友一起看看吧2022-03-03
本文主要介紹了安裝Sublime?Text支持Go插件的方法步驟，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-01-01
GO語(yǔ)言實(shí)現(xiàn)標(biāo)題閃爍效果
這篇文章主要介紹了GO語(yǔ)言實(shí)現(xiàn)標(biāo)題閃爍效果，本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07
Golang校驗(yàn)字符串是否JSON格式的方法總結(jié)
這篇文章主要為大家詳細(xì)介紹了Golang中校驗(yàn)字符串是否JSON格式的方法，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以跟隨小編一起了解一下2023-04-04
這篇文章主要介紹了淺談一下前端http與https有什么區(qū)別,現(xiàn)今大部分的網(wǎng)站都已經(jīng)使用了 https 協(xié)議,那么https對(duì)比http協(xié)議有哪些不同呢,需要的朋友可以參考下2023-04-04
GoLang的sync.WaitGroup與sync.Once簡(jiǎn)單使用講解
sync.WaitGroup類(lèi)型，它比通道更加適合實(shí)現(xiàn)這種一對(duì)多的goroutine協(xié)作流程。WaitGroup是開(kāi)箱即用的，也是并發(fā)安全的。同時(shí)，與之前提到的同步工具一樣，它一旦被真正的使用就不能被復(fù)制了2023-01-01
Go語(yǔ)言題解LeetCode455分發(fā)餅干示例詳解
這篇文章主要為大家介紹了Go語(yǔ)言題解LeetCode455分發(fā)餅干示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12