Go基礎命名規范有哪些

這篇文章主要講解了“Go基礎命名規范有哪些”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“Go基礎命名規范有哪些”吧！

基本規則

Go約定使用MixedCaps或者mixedCaps的形式，而不是下劃線來書寫多個單詞的名字。

工程名稱

1. 項目名(倉庫名）的命名可以使用字母、數字。

2. 多個單詞建議采用中劃線分隔，目前github中大多數項目都是使用用中劃線，不建議采用駝峰式分隔，不要使用下劃線(kubernetes中的組件名稱不允許使用下劃線)

3. 命名可以是對項目功能的描述；也可以是一個代號（如神話人物的名字，或者希臘語）,適合采用代號的項目有兩種，一種是公司的基礎組件或者開源項目，一般這種項目都有詳細的文檔，

4. 項目名（倉庫名）要盡量避免重復，如果可能重復要添加必要的前綴或者后綴做區分。

5. 命名盡量在三個單詞以內。

正確:

user、user-api、user-service,product、product-search、redis-go,druid、zeus、kubernetes.

錯誤:

user_api、Product

包名稱

保持package的名字和目錄保持一致，同一個文件夾所有源文件中的包名必須一致。

包名應該為小寫單詞，不要使用下劃線或者混合大小寫。

package domainpackage main

文件命名

盡量采取有意義的文件名，簡短，有意義，應該為小寫單詞，使用下劃線分隔各個單詞。

approve_service.go

結構體命名

• 采用駝峰命名法，首字母根據訪問控制大寫或者小寫
  

• struct 申明和初始化格式采用多行，例如下面：

type MainConfig struct {    Port string `json:"port"`    Address string `json:"address"`}config := MainConfig{"1234", "123.221.134"}

接口命名

• 命名規則基本和上面的結構體類型
  

• 單個函數的結構名以 “er” 作為后綴，例如 Reader , Writer 。

type Reader interface {        Read(p []byte) (n int, err error)}

變量命名

和結構體類似，變量名稱一般遵循駝峰法，首字母根據訪問控制原則大寫或者小寫，但遇到特有名詞時，需要遵循以下規則：

1. 如果變量為私有，且特有名詞為首個單詞，則使用小寫，如 appService

2. 若變量類型為 bool 類型，則名稱應以 Has, Is, Can 或 Allow 開頭

3. 作用域越小，命名應該越簡短。如在for循環內部用i表示index。

常量命名

常量均需使用全部大寫字母組成，并使用下劃線分詞

如果是枚舉類型的常量，需要先創建相應類型：

錯誤處理

• 錯誤處理的原則就是不能丟棄任何有返回err的調用，不要使用 _ 丟棄，必須全部處理。接收到錯誤，要么返回err，或者使用log記錄下來

• 盡早return：一旦有錯誤發生，馬上返回

• 盡量不要使用panic，除非你知道你在做什么

• 錯誤描述如果是英文必須為小寫，不需要標點結尾

• 采用獨立的錯誤流進行處理

單元測試

單元測試文件名命名規范為 example_test.go 測試用例的函數名稱必須以 Test 開頭，例如：TestExample 每個重要的函數都要首先編寫測試用例，測試用例和正規代碼一起提交方便進行回歸測試 。

感謝各位的閱讀，以上就是“Go基礎命名規范有哪些”的內容了，經過本文的學習后，相信大家對Go基礎命名規范有哪些這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！