如何做好代碼審查

要有審查清單

? ? ? 代碼審查這件事其實(shí)是可以標(biāo)準(zhǔn)化和流程化的赡若,其效果在一定程度上也是可以量化的列赎。要想做好代碼審查,尤其是對(duì)一個(gè)開發(fā)團(tuán)隊(duì)來(lái)說(shuō)骇窍,有一份審查清單是非常有必要的瓜晤,這樣大家就都有了一個(gè)標(biāo)準(zhǔn),可以在代碼審查過(guò)程中按照審查清單逐一檢查腹纳。使用審查清單可以幫助審查者快速找到問題活鹰,甚至開發(fā)者在開發(fā)階段就可以按照審查清單進(jìn)行代碼自查。

一般來(lái)說(shuō)只估,一份代碼審查清單應(yīng)該包括如下幾個(gè)大的類目志群。

代碼結(jié)構(gòu):是否包含超長(zhǎng)代碼,代碼層次嵌套是否過(guò)深蛔钙,函數(shù)是否入?yún)⑦^(guò)多锌云,循環(huán)條件是否有跳出點(diǎn),if語(yǔ)句是否有對(duì)應(yīng)的else語(yǔ)句吁脱,是否存在重復(fù)的代碼桑涎,等等彬向。

代碼安全性:I/O流是否正常關(guān)閉,資金計(jì)算是否使用了Double數(shù)據(jù)類型攻冷,是否有超大的臨時(shí)對(duì)象娃胆,線程池大小是否合理,異常是否被忽略等曼,是否有詳細(xì)的日志記錄里烦,是否存在并發(fā)問題,參數(shù)是否做了必要的檢查禁谦,遠(yuǎn)程服務(wù)的入?yún)⒊鰠⑹欠駥?shí)現(xiàn)了Serialization并且自定義了serialVersionUID胁黑,應(yīng)用是否依賴了SNAPSHOT版本的類庫(kù),等等州泊。

代碼性能:是否有長(zhǎng)SQL語(yǔ)句丧蘸、SQL語(yǔ)句是否用到索引,是否有成熟的類庫(kù)可以替換自己實(shí)現(xiàn)的代碼遥皂,是否可以考慮單例模式力喷,是否可以考慮線程池,是否可以考慮NIO演训,是否可以進(jìn)行鎖優(yōu)化弟孟,等等。

代碼注釋:指類及方法是否有注釋仇祭,注釋是否可以表達(dá)其準(zhǔn)確含義,在代碼中是否存在FIXME及TODO等注釋颈畸,注釋是否包含邊界值及對(duì)異常情況的說(shuō)明乌奇,等等。

單元測(cè)試:代碼是否有可測(cè)試性眯娱,新代碼是否有單元測(cè)試礁苗,單元測(cè)試是否可以覆蓋所有場(chǎng)景,等等徙缴。

代碼優(yōu)化:是否可以使用枚舉代替自定義的常量试伙,在代碼中是否包含魔法值,是否可以使用Optional代替NPE的檢查于样,是否可以使用Stream代替for循環(huán)疏叨,是否可以使用設(shè)計(jì)模式,等等穿剖。

其他:代碼邏輯是否正確蚤蔓,是否實(shí)現(xiàn)了業(yè)務(wù)功能,代碼是否有好的可讀性及可測(cè)試性糊余,等等秀又。

審查時(shí)機(jī)

? ? 代碼審查應(yīng)該是日常性的工作单寂,而不是代碼上線前的集中性工作。換句話說(shuō)吐辙,代碼審查應(yīng)該是伴隨著代碼提交的宣决,而不是伴隨著代碼發(fā)布的。最好的實(shí)踐是在每次提交改動(dòng)較大的代碼后都找到對(duì)應(yīng)的開發(fā)人員進(jìn)行代碼審查昏苏,這樣可以更早地發(fā)現(xiàn)問題尊沸,也可以使其他人更早地了解這部分新代碼。

審查代碼量不宜過(guò)多

? ? 2006年5月捷雕,Smart Bear針對(duì)Cisco進(jìn)行了為期10個(gè)月的代碼審查方面的研究椒丧,最終得到一份思科代碼審查報(bào)告(Code Review at Cisco Systems,參見http://support. smartbear.com/support/media/resources/cc/book/code-review-cisco-case-study.pdf)救巷。在該報(bào)告中指出壶熏,做代碼審查,每次審查的代碼行數(shù)最好在200行以內(nèi)浦译,不超過(guò)400行棒假,否則查找代碼缺陷的效果就會(huì)大打折扣。

出自《程序員的三門課》

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末精盅,一起剝皮案震驚了整個(gè)濱河市帽哑,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌叹俏,老刑警劉巖妻枕,帶你破解...
    沈念sama閱讀 219,270評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異粘驰,居然都是意外死亡屡谐,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門蝌数,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)愕掏,“玉大人,你說(shuō)我怎么就攤上這事顶伞《牛” “怎么了?”我有些...
    開封第一講書人閱讀 165,630評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵唆貌,是天一觀的道長(zhǎng)滑潘。 經(jīng)常有香客問我,道長(zhǎng)锨咙,這世上最難降的妖魔是什么众羡? 我笑而不...
    開封第一講書人閱讀 58,906評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上粱侣,老公的妹妹穿的比我還像新娘羊壹。我一直安慰自己,他們只是感情好齐婴,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,928評(píng)論 6 392
  • 文/花漫 我一把揭開白布油猫。 她就那樣靜靜地躺著,像睡著了一般柠偶。 火紅的嫁衣襯著肌膚如雪情妖。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,718評(píng)論 1 305
  • 那天诱担,我揣著相機(jī)與錄音毡证,去河邊找鬼。 笑死蔫仙,一個(gè)胖子當(dāng)著我的面吹牛料睛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播摇邦,決...
    沈念sama閱讀 40,442評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼恤煞,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了施籍?” 一聲冷哼從身側(cè)響起居扒,我...
    開封第一講書人閱讀 39,345評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎丑慎,沒想到半個(gè)月后喜喂,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,802評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡竿裂,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,984評(píng)論 3 337
  • 正文 我和宋清朗相戀三年玉吁,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片铛绰。...
    茶點(diǎn)故事閱讀 40,117評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡诈茧,死狀恐怖产喉,靈堂內(nèi)的尸體忽然破棺而出捂掰,到底是詐尸還是另有隱情,我是刑警寧澤曾沈,帶...
    沈念sama閱讀 35,810評(píng)論 5 346
  • 正文 年R本政府宣布这嚣,位于F島的核電站,受9級(jí)特大地震影響塞俱,放射性物質(zhì)發(fā)生泄漏姐帚。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,462評(píng)論 3 331
  • 文/蒙蒙 一障涯、第九天 我趴在偏房一處隱蔽的房頂上張望罐旗。 院中可真熱鬧膳汪,春花似錦、人聲如沸九秀。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)鼓蜒。三九已至痹换,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間都弹,已是汗流浹背娇豫。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留畅厢,地道東北人冯痢。 一個(gè)月前我還...
    沈念sama閱讀 48,377評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像或详,于是被迫代替她去往敵國(guó)和親系羞。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,060評(píng)論 2 355

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

  • 要點(diǎn) 代碼審查者在審查代碼時(shí)有非常多的東西需要關(guān)注霸琴。一個(gè)團(tuán)隊(duì)需要明確對(duì)于自己的項(xiàng)目哪些點(diǎn)是重要的椒振,并不斷在審查中就...
    kkzzzzzz閱讀 646評(píng)論 0 1
  • 第一部分 打好基礎(chǔ) Laying the Foundation 第一章 歡迎進(jìn)入軟件構(gòu)建的世界 Welcome t...
    白樺葉閱讀 4,633評(píng)論 0 17
  • 第二波月季花終于陸陸續(xù)續(xù)都開了,花型都不錯(cuò)梧乘,還很香澎迎,唯一的缺憾可能是顏色不夠鮮艷,但作為夏花來(lái)說(shuō)选调,已經(jīng)很合格啦夹供! ...
    Echo阿玖閱讀 827評(píng)論 0 1
  • 作者 簡(jiǎn)單的鏡子轉(zhuǎn)載請(qǐng)標(biāo)明原作者和出處也可以關(guān)注我的簡(jiǎn)書 EVENTS AND EMOTION ARE STORE...
    簡(jiǎn)單的鏡子閱讀 845評(píng)論 0 0
  • 美食剪報(bào)
    知足常樂章閱讀 131評(píng)論 0 0