Code Review標(biāo)準(zhǔn)

Code Reivew的目的是為了使所有代碼的代碼健康得到改善(代碼健康是指代碼的可維護(hù)性六孵,可閱讀性次乓,穩(wěn)定性及簡(jiǎn)潔性)磷雇。所有的工具魄幕,流程都是為此目的而設(shè)計(jì)的。

為了達(dá)到這一目的,我們必須權(quán)衡取舍姜凄。

首先政溃,開發(fā)人員必須針對(duì)改善代碼而有所行動(dòng),畢竟如果你從來不去改善代碼态秧,則代碼基永遠(yuǎn)不會(huì)得到改善董虱。同時(shí),評(píng)審員如果使任何變更都很難以被批準(zhǔn) ,則開發(fā)者以后就不會(huì)去改善代碼了申鱼。

另一方面愤诱,評(píng)審員有責(zé)任去保證每一次提交列表(CL)沒有降低整個(gè)代碼庫(kù)的代碼健康。這很棘手捐友,因?yàn)榇a庫(kù)整體的健康程度的下降是由于經(jīng)常性的一小部分代碼質(zhì)量下降積累而致的淫半。特別是當(dāng)一個(gè)團(tuán)隊(duì)在重大的時(shí)間限制下,他們覺得必須走捷徑以實(shí)現(xiàn)他們的目標(biāo)匣砖。

此外科吭,評(píng)審員對(duì)他們審查的代碼擁有所有權(quán)和責(zé)任。他們希望確保代碼庫(kù)保持一致猴鲫、可維護(hù)对人,以及“Code Review應(yīng)該Review什么”中提到的所有其他內(nèi)容。

因此变隔,我們得到了以下規(guī)則作為我們?cè)诖a審查中期望的標(biāo)準(zhǔn):

一般來說规伐,代碼審查者應(yīng)該通過那些絕對(duì)能提高代碼健康的但是并不完美的提交列表(CL).

這是所有代碼審查指南中的高級(jí)原則。

當(dāng)然匣缘,這是有限制的猖闪。例如,如果CL添加了評(píng)審員不希望在其系統(tǒng)中使用的功能肌厨,那么即使代碼設(shè)計(jì)良好培慌,評(píng)審員也可以拒絕批準(zhǔn)。

這里的一個(gè)關(guān)鍵點(diǎn)是柑爸,沒有所謂的“完美”代碼吵护,只有更好的代碼。評(píng)審員不應(yīng)該要求作者在批準(zhǔn)之前對(duì)CL的每一個(gè)微小部分進(jìn)行打磨表鳍。相反馅而,評(píng)審員應(yīng)該權(quán)衡取得進(jìn)展的需要和他們所建議的變更的重要性。評(píng)審員不應(yīng)該追求完美譬圣,而應(yīng)該追求持續(xù)改進(jìn)瓮恭。作為一個(gè)整體,提高系統(tǒng)的可維護(hù)性厘熟、可讀性和可理解性的CL不應(yīng)該因?yàn)樗皇恰巴昝赖摹倍七t幾天或幾周屯蹦。

評(píng)審員總是可以自由地留下評(píng)論维哈,表示某些東西可能會(huì)更好,但是如果它不是很重要登澜,可以在前面加上“Nit:”這樣的前綴阔挠,讓作者知道這只是一種修飾,他們可以選擇忽略脑蠕。

注意:在本文檔中购撼,沒有任何內(nèi)容證明檢入會(huì)明顯地惡化系統(tǒng)的整體代碼健康狀況的CL是合理的。只有在“緊急情況”下你才會(huì)這么做谴仙。

指南

代碼評(píng)審的一個(gè)重要功能是向開發(fā)人員傳授有關(guān)語(yǔ)言份招、框架或一般軟件設(shè)計(jì)原則的新知識(shí)。留下有助于開發(fā)人員學(xué)習(xí)新東西的評(píng)論總是好的狞甚。隨著時(shí)間的推移,共享知識(shí)是改善系統(tǒng)代碼健康狀況的一部分廓旬。請(qǐng)記住哼审,如果您的評(píng)論純粹是教育性的,但對(duì)于滿足本文檔中描述的標(biāo)準(zhǔn)不是至關(guān)重要的孕豹,請(qǐng)?jiān)谇懊婕由稀癗it:”或以其他方式表明作者不必在本CL中解決它涩盾。

  • 技術(shù)事實(shí)和數(shù)據(jù)壓倒了意見和個(gè)人偏好。
  • 在風(fēng)格方面励背,風(fēng)格指南是絕對(duì)權(quán)威春霍。任何沒有在樣式指南中的純樣式點(diǎn)(空格等)都是個(gè)人偏好的問題。風(fēng)格應(yīng)該與現(xiàn)有的一致叶眉。如果沒有以前的風(fēng)格址儒,那就接受作者的風(fēng)格。
  • 軟件設(shè)計(jì)的各個(gè)方面幾乎從來都不是純粹的風(fēng)格問題或個(gè)人偏好衅疙。它們是建立在基本原則基礎(chǔ)上的莲趣,應(yīng)該以這些原則為依據(jù),而不是簡(jiǎn)單地以個(gè)人觀點(diǎn)為依據(jù)饱溢。 有時(shí)有一些有效的選項(xiàng)喧伞。如果作者能夠證明(通過數(shù)據(jù)或基于可靠的工程原理)幾種方法是同樣有效的,那么評(píng)審員應(yīng)該接受作者的偏好绩郎。否則潘鲫,選擇取決于軟件設(shè)計(jì)的標(biāo)準(zhǔn)原則。
  • 如果沒有其他規(guī)則適用肋杖,那么評(píng)審員可以要求作者與當(dāng)前代碼庫(kù)中的內(nèi)容保持一致溉仑,只要這不會(huì)惡化系統(tǒng)的整體代碼健康狀況。

解決分歧

在代碼評(píng)審的任何分歧中兽愤,第一步總是讓開發(fā)人員和評(píng)審員根據(jù)本文檔的內(nèi)容和CL作者指南評(píng)審員指南中的其他文檔達(dá)成一致彼念。

當(dāng)達(dá)成一致意見變得特別困難時(shí)挪圾,通過評(píng)審員和作者之間進(jìn)行一次面對(duì)面的會(huì)議或視頻會(huì)議來解決分歧,而不是試圖通過Code Review的評(píng)論來解決逐沙。(如果您這樣做了哲思,請(qǐng)確保將討論的結(jié)果記錄在CL的評(píng)論中,以供將來的讀者參考吩案。)

如果這還不能解決問題棚赔,最常見的解決方法就是升級(jí)。通常情況下徘郭,升級(jí)的途徑是更廣泛的團(tuán)隊(duì)討論靠益,讓TL參與進(jìn)來,請(qǐng)求代碼維護(hù)者做出決定残揉,或者請(qǐng)求經(jīng)理提供幫助胧后。不要因?yàn)樽髡吆驮u(píng)審員不能達(dá)成一致意見而讓CL懸而未決。

下一章:Code Review應(yīng)該Review什么

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末抱环,一起剝皮案震驚了整個(gè)濱河市壳快,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌镇草,老刑警劉巖眶痰,帶你破解...
    沈念sama閱讀 211,376評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異梯啤,居然都是意外死亡竖伯,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,126評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門因宇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來七婴,“玉大人,你說我怎么就攤上這事羽嫡”纠眩” “怎么了?”我有些...
    開封第一講書人閱讀 156,966評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵杭棵,是天一觀的道長(zhǎng)婚惫。 經(jīng)常有香客問我,道長(zhǎng)魂爪,這世上最難降的妖魔是什么先舷? 我笑而不...
    開封第一講書人閱讀 56,432評(píng)論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮滓侍,結(jié)果婚禮上蒋川,老公的妹妹穿的比我還像新娘。我一直安慰自己撩笆,他們只是感情好捺球,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,519評(píng)論 6 385
  • 文/花漫 我一把揭開白布缸浦。 她就那樣靜靜地躺著,像睡著了一般氮兵。 火紅的嫁衣襯著肌膚如雪裂逐。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,792評(píng)論 1 290
  • 那天泣栈,我揣著相機(jī)與錄音卜高,去河邊找鬼。 笑死南片,一個(gè)胖子當(dāng)著我的面吹牛掺涛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播疼进,決...
    沈念sama閱讀 38,933評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼薪缆,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了伞广?” 一聲冷哼從身側(cè)響起矮燎,我...
    開封第一講書人閱讀 37,701評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎赔癌,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體澜沟,經(jīng)...
    沈念sama閱讀 44,143評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡灾票,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,488評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了茫虽。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片刊苍。...
    茶點(diǎn)故事閱讀 38,626評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖濒析,靈堂內(nèi)的尸體忽然破棺而出正什,到底是詐尸還是另有隱情,我是刑警寧澤号杏,帶...
    沈念sama閱讀 34,292評(píng)論 4 329
  • 正文 年R本政府宣布婴氮,位于F島的核電站,受9級(jí)特大地震影響盾致,放射性物質(zhì)發(fā)生泄漏主经。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,896評(píng)論 3 313
  • 文/蒙蒙 一庭惜、第九天 我趴在偏房一處隱蔽的房頂上張望罩驻。 院中可真熱鬧,春花似錦护赊、人聲如沸惠遏。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)节吮。三九已至抽高,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間课锌,已是汗流浹背厨内。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留渺贤,地道東北人雏胃。 一個(gè)月前我還...
    沈念sama閱讀 46,324評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像志鞍,于是被迫代替她去往敵國(guó)和親瞭亮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,494評(píng)論 2 348