Golang命名规范

请使用Goland编辑器使用,设置请看goland设置篇

package名字

保持package的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。

常量声明

// 常量只能由英文字母组成
// 全部大写
const  DIR = "/static/pic"

变量声明

// 变量只能由英文字母组成
// 变量全部使用小驼峰命名,根据是有需要导出决定首字母是否大写
// 多个变量申明使用var括号
var (
    userAge int
    userName  stirng
)

//局部变量声明
// 需要实力化,使用短变量声明
userName :=  "jack"
// 不需要实力化,使用var关键字声明,此种方式一般用于赋值
var  userName  string

函数命名

// 函数名称只能由字母组成
//  函数名称采用小驼峰方式,根据是有需要导出决定首字母是否大写
// 函数的参数名称简短那有意义
// 函数体内的代码行数保持在10-15行之间,不要超过20行,此时必须进行方法内容的抽取,将其抽取成多个方法,减少耦合,提高复用
// 函数返回值超过两个参数,则必须给返回值命名
func  getUserInfo(id int) (userInfo  interface{}, err   error){

}

结构体命名

// 函数名称只能由字母组成
//  函数名称采用小驼峰方式,根据是有需要导出决定首字母是否大写
命名规则基本和上面的结构体类型
// 结构体字段命名同结构体命名一致
// 每个字段独占一行
type UserInfo struct{
    UserName  string
    UserAge     int
}

接口命名

// 函数名称只能由字母组成
//  函数名称采用小驼峰方式,根据是有需要导出决定首字母是否大写
命名规则基本和上面的结构体类型
// 接口名称以 “er” 作为后缀,例如 Reader , Writer 。
type Reader interface {
        Read(p []byte) (n int, err error)
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 一、项目目录结构规范 文件名命名规范 文件名命名规范 小驼峰命名方式,看见文件名就可以知道这个文件下的大概内容。例...
    My_Fuzz阅读 2,498评论 0 7
  • gofmt 大部分的格式问题可以通过gofmt解决,gofmt自动格式化代码,保证所有的go代码一致的格式。 正常...
    土豆_大大阅读 969评论 0 51
  • gofmt 大部分的格式问题可以通过gofmt解决,gofmt自动格式化代码,保证所有的go代码与官方推荐的格式保...
    莫云溪阅读 9,699评论 2 16
  • 一、注释 推荐使用C语言风格的 “//” 注释。注释必须是完整的句子,尽量简明,以句点结尾。程序中每一个可被导出的...
    岳阳小罗阅读 3,384评论 1 4
  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,878评论 0 38