Golang code review comments 【譯文】

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

注釋

  • 注釋應(yīng)該是一段完整的語句
  • 注釋應(yīng)該以所描述內(nèi)容的名字開頭儒喊,并且以句號結(jié)尾

聲明空的切片

應(yīng)該使用: var t []string, 而不是: t := []string{}
前者會避免內(nèi)存分配,除非使用了append()

不要使用panic

對于普通的錯誤處理,不要使用panic,使用error和多返回值洪碳,

錯誤字符串

  • 錯誤字符串不應(yīng)該大寫(除非是專有名詞或者縮寫)
  • 不要以符號結(jié)尾

錯誤處理

不要使用_去丟棄error. 當(dāng)一個函數(shù)返回error,去檢查并處理error,或者在真正的異常情形下,panic

import

將多個import以組劃分锄奢,用空行來區(qū)分組谣光,標(biāo)準(zhǔn)包放在最上面

可以使用goimports來格式化

import dot

除非在test 文件中有循環(huán)依賴而去使用import . 這種形式弹谁,否則不要在你的程序中去使用茸塞,
它使你的程序難以閱讀野瘦,因為你很難清楚的知道它所處的層級關(guān)系描沟。

縮進(jìn)錯誤

盡量保持正常代碼最小的縮進(jìn)飒泻,縮進(jìn)錯誤處理代碼并且優(yōu)先處理。
盡量采取

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

不要

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

縮寫

縮略應(yīng)該保持一致吏廉,例如: url/URL, 而不是Url, 這個規(guī)則同樣適用于當(dāng)ID作為一個標(biāo)識的時候泞遗,使用appID而不是appId

包名

所有對包內(nèi)的引用都應(yīng)該使用包名去訪問,因此包內(nèi)的名稱引用可以去掉包名這個標(biāo)識席覆。
例如:包chubby, 不需要使用ChubbyFile, 使用者調(diào)用方式為:chubby.ChubbyFil,
而是使用File史辙,使用者調(diào)用形式為:chubby.File

接收者類型

當(dāng)不知如何抉擇值接收還是指針接收時,使用指針接收佩伤。但有時值接收是有意義的聊倔,尤其是效率因素,對于不常變的小的結(jié)構(gòu)體生巡,基礎(chǔ)類型的值耙蔑。
下面是一些有用的指導(dǎo):

  • 如果receiver是map,func,chan,不使用指針
  • 如果receiver是slice,當(dāng)方法不會重組或重新分配切片障斋,不使用指針
  • 如果方法需要改變receiver,必須使用指針
  • 當(dāng)receiver是包含鎖或同步字段時纵潦,必須使用指針以避免復(fù)制
  • 對于大的結(jié)構(gòu)體或數(shù)組,指針更加的高效
  • 當(dāng)外面的改動必須影響到原始的receiver時垃环,必須使用指針
  • 最后邀层,如果懷疑,那么請使用指針

變量名稱

go中變量名應(yīng)該盡可能的短遂庄,尤其是有作用域的局部變量寥院。
基本原則:

  • 變量越是遠(yuǎn)離聲明,名稱越要具有描述性
  • 全局變量或不常見的應(yīng)該使用描述性的名稱
  • 對于方法的接收者涛目,一兩個字母就足夠了
  • 常見的變量可以使用單個字符秸谢,如循環(huán)次數(shù) i
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市霹肝,隨后出現(xiàn)的幾起案子估蹄,更是在濱河造成了極大的恐慌,老刑警劉巖沫换,帶你破解...
    沈念sama閱讀 216,919評論 6 502
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件臭蚁,死亡現(xiàn)場離奇詭異,居然都是意外死亡讯赏,警方通過查閱死者的電腦和手機垮兑,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,567評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來漱挎,“玉大人系枪,你說我怎么就攤上這事】牧拢” “怎么了私爷?”我有些...
    開封第一講書人閱讀 163,316評論 0 353
  • 文/不壞的土叔 我叫張陵雾棺,是天一觀的道長。 經(jīng)常有香客問我当犯,道長垢村,這世上最難降的妖魔是什么割疾? 我笑而不...
    開封第一講書人閱讀 58,294評論 1 292
  • 正文 為了忘掉前任嚎卫,我火速辦了婚禮,結(jié)果婚禮上宏榕,老公的妹妹穿的比我還像新娘拓诸。我一直安慰自己,他們只是感情好麻昼,可當(dāng)我...
    茶點故事閱讀 67,318評論 6 390
  • 文/花漫 我一把揭開白布奠支。 她就那樣靜靜地躺著,像睡著了一般抚芦。 火紅的嫁衣襯著肌膚如雪倍谜。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,245評論 1 299
  • 那天叉抡,我揣著相機與錄音尔崔,去河邊找鬼。 笑死褥民,一個胖子當(dāng)著我的面吹牛季春,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播消返,決...
    沈念sama閱讀 40,120評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼载弄,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了撵颊?” 一聲冷哼從身側(cè)響起宇攻,我...
    開封第一講書人閱讀 38,964評論 0 275
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎倡勇,沒想到半個月后逞刷,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,376評論 1 313
  • 正文 獨居荒郊野嶺守林人離奇死亡译隘,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,592評論 2 333
  • 正文 我和宋清朗相戀三年亲桥,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片固耘。...
    茶點故事閱讀 39,764評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡题篷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出厅目,到底是詐尸還是另有隱情番枚,我是刑警寧澤法严,帶...
    沈念sama閱讀 35,460評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站葫笼,受9級特大地震影響深啤,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜路星,卻給世界環(huán)境...
    茶點故事閱讀 41,070評論 3 327
  • 文/蒙蒙 一溯街、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧洋丐,春花似錦呈昔、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,697評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至迁客,卻和暖如春郭宝,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背掷漱。 一陣腳步聲響...
    開封第一講書人閱讀 32,846評論 1 269
  • 我被黑心中介騙來泰國打工粘室, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人切威。 一個月前我還...
    沈念sama閱讀 47,819評論 2 370
  • 正文 我出身青樓育特,卻偏偏與公主長得像,于是被迫代替她去往敵國和親先朦。 傳聞我的和親對象是個殘疾皇子缰冤,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,665評論 2 354

推薦閱讀更多精彩內(nèi)容

  • error code(錯誤代碼)=0是操作成功完成。error code(錯誤代碼)=1是功能錯誤喳魏。error c...
    Heikki_閱讀 3,379評論 1 9
  • *面試心聲:其實這些題本人都沒怎么背,但是在上海 兩周半 面了大約10家 收到差不多3個offer,總結(jié)起來就是把...
    Dove_iOS閱讀 27,139評論 30 470
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理棉浸,服務(wù)發(fā)現(xiàn),斷路器刺彩,智...
    卡卡羅2017閱讀 134,654評論 18 139
  • 轉(zhuǎn)至元數(shù)據(jù)結(jié)尾創(chuàng)建: 董瀟偉迷郑,最新修改于: 十二月 23, 2016 轉(zhuǎn)至元數(shù)據(jù)起始第一章:isa和Class一....
    40c0490e5268閱讀 1,709評論 0 9
  • A1:回顧過去的讀書方法,我是怎么選書的呢 1.去書店閑逛的時候看到展示的圖書创倔,有感興趣的會翻幾頁嗡害,翻了幾頁覺得不...
    西寶阿加西閱讀 339評論 1 0