Golang编码规范

Posted 2022-08-17 leafs99

原文链接：https://github.com/golang/go/wiki/CodeReviewComments
1）用 goimport 代替 gofmt
2) https://golang.org/doc/effective_go.html#commentary
注释单独一行，开始于描述的名字，结束于。。没看明白
3）context.Context的值包含：跨API和流程边界的安全凭证，跟踪信息，截止日期和取消信号。
大多数函数用Context应该作为第一个参数接收
从不特别请求的函数可以使用context.Background(), 即使不要，也要在传递Context时使用err
默认情况是传递Context;如果你有充分的理由认为替代方案是错误的，那么只能直接使用context.Background（）。
不要把Context添加到结构体中，而是把它作为参数加在每个这个类型的方法里面，一个例外是签名必须与标准库或第三方库中的接口匹配的方法。
不要在函数签名中自定义类型或者使用其他接口而不是Context
如果要传递应用程序数据，请将其放在参数中，接收器中，全局变量中，或者如果它真正属于那里，则放在Context值中。
Context是不变的，所以传相同的值没关系
4）如果一个类型的方法都与它的指针有关，就不要直接复制它的值
5）声明空slice：
var t []string : OK 空的slice
t := []string : NO 非空长度为0的slice

但是有些情况下，第二个好点，比如编码JSON对象（nil->null, []string->array[])
6) 使用”crypto/rand”而尽量不要用”math/rand”
7) 所有顶层，导出的名字应该都有文字说明，包括一些重要的不导出的类型和函数声明
8）不要使用panic来控制error，使用error和多返回值
9) error的string context中的内容格式：头字母小写，结尾不带标点，因为error会在句子中组合成消息
但是这不适用于日志记录，它隐含地面对行，而不在其他消息内组合
10）当添加一个新的包时，要包含简单实例：一个可执行的例子，或者一个演示完整调用序列的简单测试
11）当大量使用goroutine时，弄清楚什么时间，以及他们是否退出
goroutine会在通道上发送或者接收阻塞时泄漏，垃圾收集器将不会终止goroutine，即使阻塞的信道是不可达的
尽量让代码简洁，使goroutine的寿命明显，如果不能，就加入文档说明什么时候为什么退出
12）不要用_丢弃error，如果一个函数返回一个error，就检查它确保函数成功运行，处理error，返回它，或者panic
13）避免重命名导入的，除非是为了避免命名冲突，冲突了的话，最好去重命名最本地或者项目特定的导入
导入按租划分，空行隔开，标准库的包通常在第一组
Goimports会做这些, 为什么我没有呢？？？？
14）

import(
“bar/testutil” //also imports “foo”
. “foo”
)

这种.的形式在测试中很有用，由于循环依赖性，测试不能成为测试包的一部分,”bar/testutil”包中有foo，做一在这里用 . 来假装在这个包里面引入，除了这种情况，其他情况都不要用这个点
15）函数多返回值，用一个bool来表示是否返回了有用的值
总的来说，go代码需要另外的值来表示error
16）代码中尽量减少缩进，else可以直接放外边啥的
17）对于缩写词，命名全部使用大写或者小写（URL,HTTP,ID,,,)
协议缓冲区编译器生成的代码不受此规则的约束（虽然还不晓得这是啥）
18）Go接口通常属于使用接口类型值的包，而不是实现这些值的包。
实现包应返回具体的类型（结构或者指针），这样可以将新方法添加到实现中，而无需大量重构
不要在一个API的实现者端定义接口，相反，设计API以便可以使用真实实现的公共API进行测试
例子没看懂2333
19）控制句子长度，（名字太长？）函数太长功能太弱？
20）命名不用下划线，驼峰命名法？缩写词同第17条
21）命名返回值参数：
godoc之类，不要命名，只放类型
但是如果有多个类型相同的返回值，可以命名其中一些
函数体积较大时还是命名了比较好，defer 闭包里最好用下
22）包名之前的注释要紧挨着，main包的注释可以”Binary”/“Command”…开头加目录名
包注释要首字母大写
23）包名字全小写
24）小型结构：不要用指针传参数，如果函数将其参数x仅引用为* x，那么参数不应该是指针。此常见实例包括将指针传递给字符串（* string）或指向接口值（* io.Reader）的指针。
25）变量命名尽量简洁
26）用指针还是值：
a. 如果接受者是map，func，chan，不要用指针
27）尽量使用并发，goroutine很容易添加，但是包不容易删去
28）编写失败情况的测试输出：
actual != expected
在使用具有不同输入的测试助手时消除失败测试的另一种常见技术是使用不同的TestFoo函数包装每个调用者
29) 变量名应该用的越久越要具体