Code Review

一、什么是 Code Review?

顧名思義耗跛,Code Review就是代碼再次查看評審。那么一個成熟的開發(fā)團隊為什么要做 Code Review?對于經驗不足或者剛開始一份新工作的人來說,通過 Code Review 可以得到更資深的人幫助荷逞,更快熟悉現(xiàn)有的規(guī)范和架構道伟,在新的環(huán)境和團隊中快速提升迹缀。對于資深的工程師來說,讓其他同事 review 代碼蜜徽,有利于在團隊中傳播經驗祝懂、知識和好的實踐。

二拘鞋、我們團隊期望實施 Code Review后可以達到的效果

1砚蓬、短期內迅速提高代碼質量
大家能在 Review 的過程中學習到其他同事優(yōu)秀的編碼方式和習慣。
2盆色、團隊成員對項目的熟悉程度會比較均衡灰蛙。
同事通過參與Code Review能很快熟悉團隊的規(guī)范。
3隔躲、改善團隊的氛圍
Review的過程中會需要非常多的溝通摩梧,多溝通能拉近團隊成員的距離。

三宣旱、Code Review 主要檢查的點
本次以圖像測試平臺為例:

1仅父、完整性檢查
代碼是否完全實現(xiàn)了由管理員創(chuàng)建項目、到標注員領包浑吟、標注笙纤、打分的完整流程。
代碼是否已創(chuàng)建了需要的數據庫组力,包括正確的初始化數據
代碼中是否存在任何沒有定義或沒有引用到的變量省容、常數或數據類型
2、一致性檢查
代碼的邏輯是否符合設計文檔
代碼中使用的格式燎字、符號腥椒、結構等風格是否保持一致
3阿宅、正確性檢查
所有的變量都被正確定義和使用
所有的注釋都是準確的
所有的程序調用都使用了正確的參數個數
4、可修改性檢查
代碼涉及到的常量是否易于修改(如項目配置寞酿、項目類型家夺、項目的分類及難度調整)
5、可重用性
原則:同一代碼不應該重復兩次以上伐弹,考慮可重用的服務拉馋,功能和組件,考慮通用函數和類
6惨好、可擴展性
本次上線的矩形標注平臺煌茴,下次增加多邊形標注功能需要變動哪些模塊?是否留有擴展功能

四日川、Code Review 的步驟

1蔓腐、周四早晨 10 點,由趙騏和焦世豪講解自己負責的圖像測試平臺的代碼和相關邏輯龄句;
2回论、參與者在此過程中可以隨時提出自己的疑問,同時積極發(fā)現(xiàn)隱藏的bug分歇;由趙騏對這些bug記錄在案傀蓉。
3、趙騏和焦世豪根據大家給出的修改意見职抡,記錄下問題及修改意見葬燎,有不清楚的地方可積極向意見提出者提出。
4缚甩、趙騏把Code Review中發(fā)現(xiàn)的有價值的問題更新到"代碼審核規(guī)范"的文檔中谱净。

五、備注

要經常性的進行 Code Review擅威,因為程序員代碼寫得時候越長壕探,程序員就會在代碼中加入越來越多的個人的東西。
人數不要多郊丛,3-5 人小型會議最佳浩蓉。
Code Review 不要太正式,Code Review不是批斗大會宾袜,輕松的氛圍能激發(fā)大家的積極性。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末驾窟,一起剝皮案震驚了整個濱河市庆猫,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌绅络,老刑警劉巖月培,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件嘁字,死亡現(xiàn)場離奇詭異,居然都是意外死亡杉畜,警方通過查閱死者的電腦和手機纪蜒,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來此叠,“玉大人纯续,你說我怎么就攤上這事∶鹪” “怎么了猬错?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長茸歧。 經常有香客問我倦炒,道長,這世上最難降的妖魔是什么软瞎? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任逢唤,我火速辦了婚禮,結果婚禮上涤浇,老公的妹妹穿的比我還像新娘鳖藕。我一直安慰自己,他們只是感情好芙代,可當我...
    茶點故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布吊奢。 她就那樣靜靜地躺著,像睡著了一般纹烹。 火紅的嫁衣襯著肌膚如雪页滚。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天铺呵,我揣著相機與錄音裹驰,去河邊找鬼。 笑死片挂,一個胖子當著我的面吹牛幻林,可吹牛的內容都是我干的。 我是一名探鬼主播音念,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼沪饺,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了闷愤?” 一聲冷哼從身側響起整葡,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎讥脐,沒想到半個月后遭居,有當地人在樹林里發(fā)現(xiàn)了一具尸體啼器,經...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年俱萍,在試婚紗的時候發(fā)現(xiàn)自己被綠了端壳。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,117評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡枪蘑,死狀恐怖损谦,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情腥寇,我是刑警寧澤成翩,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站赦役,受9級特大地震影響麻敌,放射性物質發(fā)生泄漏。R本人自食惡果不足惜掂摔,卻給世界環(huán)境...
    茶點故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一术羔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧乙漓,春花似錦级历、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至涩蜘,卻和暖如春嚼贡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背同诫。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工粤策, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人误窖。 一個月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓叮盘,卻偏偏與公主長得像,于是被迫代替她去往敵國和親霹俺。 傳聞我的和親對象是個殘疾皇子柔吼,可洞房花燭夜當晚...
    茶點故事閱讀 45,060評論 2 355

推薦閱讀更多精彩內容