注释

可以通过//或者//增加注释,//之后应该有个空格
如果想在每个文件的头部加上注释,需要在版权注释和Package前面加一个空行,否则版权注释会作为package的注释。
编写地道的Go代码 - 图1
注:注释应该用一个完整的句子,注释的第一个单词应该是要注释的指示符,以便在godoc中容易查找;注释应该以.结尾;

声明slice

使用下面这种方式声明slice:

  1. var s []string

而不是下面这种格式

  1. t := []string{}

注:前者声明了一个nilsilce,而后者声明了一个长度为0的非nilslice。

字符串的大小写

错误字符串不应该大写,应写成:

  1. fmt.Errorf("failed to write data.")

而不是写成:

  1. fmt.Errorf("Failed to write data")

因为这些字符串可能和其他字符串相连接,组合后的字符串如果中间有大写字母开头的单词很突兀,除非这些首字母大写单词是固定使用的单词。

注:缩写词必须保持一致,比如都大写URL或者小写url;常量一般声明为MaxLength,而不是以下划线分割MAX_LENGTH或者MAXLENGTH;

处理erro而不是panic或忽略

为了代码的强健性,不要使用_忽略错误,而是要处理每一个错误,尽管代码写起来有些繁琐也不要忽略错误;
尽量不要使用panic;

一些名称

包名应该使用单数形式,比如util,model, 而不是utils,models;
Reciver的名称应该缩写,一般使用一个或两个字符作为Receiver的名字,如:
编写地道的Go代码 - 图2
有些单词可能有多种写法,在项目中应保持一致,比如Golang采用的写法:
编写地道的Go代码 - 图3
而不是:
编写地道的Go代码 - 图4

空字符串检查

正确方式:

  1. if s == "" {
  2. ...
  3. }

而不是:

  1. if len(s) == 0 {
  2. ...
  3. }

更不是:

  1. if s == nil || s == ""{
  2. ...
  3. }

非空slice检查

正确方式:

  1. if len(s) > 0 {
  2. ...
  3. }

而不是:

  1. if s != nil && len(s) > 0 {
  2. ...
  3. }

直接使用bool值

对于bool类型的变量var b bool,直接使用它作为判断,而不是使用它和true/false进行比较:

正确方式:

  1. if b {
  2. ...
  3. }
  4. if !b {
  5. ...
  6. }

而不是

  1. if b == true {
  2. ...
  3. }
  4. if b == false {
  5. ...
  6. }

byte/slice/string相等性比较

  1. var s1 []byte
  2. var s2 []byte
  3. ...
  4. bytes.Equal(s1, s2) == 0
  5. bytes.Equal(s1, s2) != 0

而不是:

  1. var s1 []byte
  2. var s2 []byte
  3. ...
  4. bytes.Compare(s1, s2) == 0
  5. bytes.Compare(s1, s2) != 0

检查是否包含自字符串

应使用strings.ContainesRune, strings.ContainesAny, strings.Coutains

复制slice

使用内建函数copy,而不是遍历slice逐个复制

  1. var b1, b2 []byte
  2. copy(b2, b1)

尽量缩短if

正确方式:

  1. var a, b int
  2. ...
  3. return a > b

而不是:

  1. var a, b int
  2. ...
  3. if a > b {
  4. return true
  5. } else {
  6. return false
  7. }

简化range

正确方式:

  1. for range m {
  2. ...
  3. }

而不是:

  1. var m map[string]int
  2. for _ = range m {
  3. }
  4. for _, _ = range m {
  5. }

使用strings.TrimPrefix / strings.TrimSuffix

正确方式:

  1. var s1 = "a string value"
  2. var s2 = "a "
  3. var s3 = strings.TrimPrefix(s1, s2)

而不是:

  1. var s1 = "a string value"
  2. var s2 = "a "
  3. var s3 string
  4. if strings.HasPrefix(s1, s2) {
  5. s3 = s1[len(s2):]
  6. }

.append slice

正确方式:

  1. var a, b []byte
  2. a = append(b, a...)

而不是:

  1. var a, b []byte
  2. for _,v range a {
  3. append(b, v)
  4. }

编写地道的Go代码 - 图5