最规范的Go代码就是Go的标准库的代码,有条件的时候可以多看看Google的工程师是如何实现的。
注释
可以通过/ … /或者//注释, //之后应该有个空格。
如果想在每个文件的头部加上注释,需要在版权注释和Package前面加一个空行,否则版权注释会作为package的注释
注释:注释应该用一个完整的句子,注释的第一个单词应该是要注释的提示符,以便在godoc中容易查找;注释应该以.结尾。
声明slice
使用下面这种方式声明slice:
而不是下面这种格式:
字符串的大小写
错误字符串不应该大写,应写成:
而不是写成:
因为,这些字符串可能和其他字符串相连接,组合后的字符串如果中间有大写字母开头的单词很突兀,除非这些首字母大写单词是固定使用的单词。
注:缩写词必须保持一致,比如都大写URL或小写url;常量一般声明为MaxLength,而不是以下划线分割MAX_LENGTH或者MAXLENGTH;
处理error而不是panic或者忽略
为了代表的强健性,不要使用_忽略错误,而是要处理每一个错误,尽管代码写起来有些繁琐也不要忽略错误;
尽量不要使用panic;
一些名称
包名应该使用单数形式,比如util,model,而不是utils,models;
Receiver的名称应该缩写,一般使用一个或两个字符作为Receiver的名称,如:
有些单词可能有多种写法,在项目中应该保持一致,比如Golang采用的写法:
而不是:
空字符串检查
正确方式:
而不是:
更不是:
非空slice检查
正确方式:
而不是:
直接使用bool值
对于bool类型的变量var b bool,直接使用它作为判断,而不是使用它和true/false进行比较:
正确方式:
而不是:
byte/slice/string相等性比较
而不是:
检查是否包含子字符串
应使用strings.ContainesRune, strings.ContainesAny, strings.Contains
复制slice
使用内建函数copy,而不是遍历slice逐个复制:
尽量缩短if
正确使用方式:
而不是:
简化range
正确方式:
而不是:
使用strings.TrimPrefix/ string.TrimSuffix
正确方式:
而不是:
append slice
正确方式:
而不是: