golang命名规范

命名规则

1. golang的变量函数命名需要使用驼峰命名法，且不能出现下划线, 文件名使用下划线
2. golang中根据首字母的大小写来确定可以访问的权限。无论是方法名、常量、变量名还是结构体的名称，如果首字母大写，则可以被其他的包访问；如果首字母小写，则只能在本包中使用可以简单的理解成: 首字母大写是公有的，首字母小写是私有的文件的命名，全小写，测试的文件：xxx_test.go包名和文件夹名字最好一样

变量命名规则

• 变量命名命名必须清晰、明了，有明确含义的单词，命名中禁止使用缩写，除非已是业界通用或标准化的缩写；
• 单字母名称仅适用于短方法中的局部变量，名称长短应与其作用域相对应。若变量或常量可能在代码中多处使用，则应赋其以便于搜索的名称且有意义的名称。
• 变量名称一般遵循驼峰法，但遇到特有名词时，需要遵循以下规则：如果变量为私有，且特有名词为首个单词，则使用小写，如 apiClient，其它情况都应当使用该名词原有的写法，如APIClient、repoID、UserID
  错误示例：UrlArray，应该写成urlArray或者URLArray

一些常见的特有名词：
// A GonicMapper that contains a list of common initialisms taken from golang/lint
var LintGonicMapper = GonicMapper{
    "API":   true,
    "ASCII": true,
    "CPU":   true,
    "CSS":   true,
    "DNS":   true,
    "EOF":   true,
    "GUID":  true,
    "HTML":  true,
    "HTTP":  true,
    "HTTPS": true,
    "ID":    true,
    "IP":    true,
    "JSON":  true,
    "LHS":   true,
    "QPS":   true,
    "RAM":   true,
    "RHS":   true,
    "RPC":   true,
    "SLA":   true,
    "SMTP":  true,
    "SSH":   true,
    "TLS":   true,
    "TTL":   true,
    "UI":    true,
    "UID":   true,
    "UUID":  true,
    "URI":   true,
    "URL":   true,
    "UTF8":  true,
    "VM":    true,
    "XML":   true,
    "XSRF":  true,
    "XSS":   true,
}

函数命名规则

驼峰式命名，名字可以长但是得把功能，必要的参数描述清楚，函数名名应当是动词或动词短语，如postPayment、deletePage、save。并依Javabean标准加上get、set、is前缀。例如：xxx + With + 需要的参数名 + And + 需要的参数名 + …..

结构体命名规则

• 结构体名应该是名词或名词短语，如Custome、WikiPage、Account、AddressParser，WriteDbMgr，ConfMgr，避免使用Manager、Processor、Data、Info等类名，而且类名不应当是动词。
• 结构体中属性名大写，如果属性名小写则在数据解析（如json解析,或将结构体作为请求或访问参数）时无法解析

包名命名规则

包名应该为小写单词，不要使用下划线或者混合大小写。

接口命名规则

单个函数的接口名以”er”作为后缀，如Reader,Writer。接口的实现则去掉“er”。
type Reader interface {
    Read(p []byte) (n int, err error)
}

//两个函数的接口名综合两个函数名
type WriteFlusher interface {
    Write([]byte) (int, error)
    Flush() error
}

//三个以上函数的接口名，抽象这个接口的功能，类似于结构体名
type Car interface {
    Start([]byte) 
    Stop() error
    Recover()
}

注释

在编码阶段应该同步写好变量、函数、包的注释，最后可以利用godoc导出文档。注释必须是完整的句子，句子的结尾应该用句号作为结尾（英文句号）。注释推荐用英文，可以在写代码过程中锻炼英文的阅读和书写能力。而且用英文不会出现各种编码的问题。
每个包都应该有一个包注释，一个位于package子句之前的块注释或行注释。包如果有多个go文件，只需要出现在一个go文件中即可。

// log包实现了常用的log相关的函数
package log 

导出函数注释，第一条语句应该为一条概括语句，并且使用被声明的名字作为开头。
// 求a和b的和,返回sum.
func Myfunction(a, b int) (sum int){

}

常量

• 常量均需使用全部大写字母组成，并使用下划线分词：const APP_VER = “1.0”
• 如果是枚举类型的常量，需要先创建相应类型：

type Scheme string
const (
    HTTP  Scheme = "http"
    HTTPS Scheme = "https"
)

• 如果模块的功能较为复杂、常量名称容易混淆的情况下，为了更好地区分枚举类型，可以使用完整的前缀：

type PullRequestStatus int
const (
    PULL_REQUEST_STATUS_CONFLICT PullRequestStatus = iota
    PULL_REQUEST_STATUS_CHECKING
    PULL_REQUEST_STATUS_MERGEABLE
)

变量规则举例

• 变量命名基本上遵循相应的英文表达或简写,在相对简单的环境（对象数量少、针对性强）中，可以将一些名称由完整单词简写为单个字母，例如：
  – user 可以简写为 u
  – userID 可以简写 uid
  – 若变量类型为 bool 类型，则名称应以 Has, Is, Can 或 Allow 开头：

var isExist bool
var hasConflict bool
var canManage bool
var allowGitHook bool

import

对import的包进行分组管理，用换行符分割，而且标准库作为分组的第一组。如果你的包引入了三种类型的包，标准库包，程序内部包，第三方包，建议采用如下方式进行组织你的包

import (
    "github.com/bitly/go-simplejson"
    "strconv"
    "container/list"
    "gopkg/utils"
)

在项目中不要使用相对路径引入包：import “../utils”

参数传递

• 对于少量数据，不要传递指针
• 对于大量数据的struct可以考虑使用指针
• 传入参数是map，slice，chan不要传递指针，因为map，slice，chan是引用类型，不需要传递指针的指针

单元测试

• 单元测试文件名命名规范为 example_test.go
• 测试用例的函数名称必须以 Test 开头，例如：TestExample