Golang code review comments 【译文】

翻译自:https://github.com/golang/go/wiki/CodeReviewComments

注释

  • 注释应该是一段完整的语句
  • 注释应该以所描述内容的名字开头,并且以句号结尾

声明空的切片

应该使用: var t []string, 而不是: t := []string{}
前者会避免内存分配,除非使用了append()

不要使用panic

对于普通的错误处理,不要使用panic,使用error和多返回值,

错误字符串

  • 错误字符串不应该大写(除非是专有名词或者缩写)
  • 不要以符号结尾

错误处理

不要使用_去丢弃error. 当一个函数返回error,去检查并处理error,或者在真正的异常情形下,panic

import

将多个import以组划分,用空行来区分组,标准包放在最上面

可以使用goimports来格式化

import dot

除非在test 文件中有循环依赖而去使用import . 这种形式,否则不要在你的程序中去使用,
它使你的程序难以阅读,因为你很难清楚的知道它所处的层级关系。

缩进错误

尽量保持正常代码最小的缩进,缩进错误处理代码并且优先处理。
尽量采取

if err != nil {
    // error handling
    return // or continue, etc.
}
// normal code

不要

if err != nil {
    // error handling
} else {
    // normal code
}

缩写

缩略应该保持一致,例如: url/URL, 而不是Url, 这个规则同样适用于当ID作为一个标识的时候,使用appID而不是appId

包名

所有对包内的引用都应该使用包名去访问,因此包内的名称引用可以去掉包名这个标识。
例如:包chubby, 不需要使用ChubbyFile, 使用者调用方式为:chubby.ChubbyFil,
而是使用File,使用者调用形式为:chubby.File

接收者类型

当不知如何抉择值接收还是指针接收时,使用指针接收。但有时值接收是有意义的,尤其是效率因素,对于不常变的小的结构体,基础类型的值。
下面是一些有用的指导:

  • 如果receiver是map,func,chan,不使用指针
  • 如果receiver是slice,当方法不会重组或重新分配切片,不使用指针
  • 如果方法需要改变receiver,必须使用指针
  • 当receiver是包含锁或同步字段时,必须使用指针以避免复制
  • 对于大的结构体或数组,指针更加的高效
  • 当外面的改动必须影响到原始的receiver时,必须使用指针
  • 最后,如果怀疑,那么请使用指针

变量名称

go中变量名应该尽可能的短,尤其是有作用域的局部变量。
基本原则:

  • 变量越是远离声明,名称越要具有描述性
  • 全局变量或不常见的应该使用描述性的名称
  • 对于方法的接收者,一两个字母就足够了
  • 常见的变量可以使用单个字符,如循环次数 i
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • error code(错误代码)=0是操作成功完成。error code(错误代码)=1是功能错误。error c...
    Heikki_阅读 3,355评论 1 9
  • *面试心声:其实这些题本人都没怎么背,但是在上海 两周半 面了大约10家 收到差不多3个offer,总结起来就是把...
    Dove_iOS阅读 27,121评论 29 470
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,678评论 0 9
  • A1:回顾过去的读书方法,我是怎么选书的呢 1.去书店闲逛的时候看到展示的图书,有感兴趣的会翻几页,翻了几页觉得不...
    西宝阿加西阅读 332评论 1 0