go语言规范 | 青训营

69 阅读2分钟

前言:

最开始的时候,我们小组内的都是大二大三的新手,都没有非常的理解这一块内容。直到后面有队伍合并到我们的队伍里面之后,他指出了我们有很多的不规范,然后我们才开始注意到这里的内容,所以就总结了一下这些内容。

为什么要规范

规范的效果是为了可以提高代码的可读性,可维护性和可理解性。尤其是可理解性,当时队友的加入,我们的不规范让他们在理解代码的时候废了好大的劲。

基本命名的规则

1、类似于Java,必须以字母或者下划线(_)开头,其他的字符是都不可以的
2、除了开头,其他的位置除了可以用字母和下划线之外,还可以用数字0-9使用
3、go语言区分大小写,A和a是两个不同的标识符
4、和go一样,不可以使用关键来作为标识符
标识符包括:
break case chan const continue
default defer else fallthrough for
func go goto if import
interface map package range return
select struct switch type var

接口的命名

接口的命名是我们一直没有留意过的,以至于之前错误了好久。go语言中接口的命名首先是要表示要描述的对象的功能,其次往往在对应的名称的后面加上“er”结尾,例如InsertVideoer等等。

type InsertVideoer interface{
    ...
}

变量的命名

类似于Java,使用驼峰命名法,而不同在于首字母,要根据访问控制权限大写或者小写。想同的时,首先变量是要有意义的,不要用 a int这样子来命名,这样子没有实际的意义;在大小写上面,如果是私有变量,并且特有名词时便连忙的首个字母,应该使用小写,例如userNmae;其它情况则都是大写驼峰UserNmae。

常量命名

全大写+分隔用“_”

注释

单行注释: // 多行注释: /**/

//单行注释

/*
注释1
注释2
*/

结构体的命名

具有描述性,能够放遇实际的意义的实体;使用大写驼峰命名法,即首字母就大写,不要用蛇形,即不要用下划线;尽可能不要用缩写,让可读性充足。