CodeReview

CodeReview 的方式

開 Code Review 會議

團(tuán)隊(duì)內(nèi)部會整理 Check List

團(tuán)隊(duì)內(nèi)部成員交換代碼

找出可優(yōu)化方案

多問問題职烧,例如:“這塊兒是怎么工作的扁誓?”防泵、“如果有XXX 情況,你這個(gè)怎么處理蝗敢?”

區(qū)分重點(diǎn)捷泞,優(yōu)先抓住設(shè)計(jì),可讀性寿谴,健壯性等重點(diǎn)問題

整理好的編碼實(shí)踐锁右,用來作為 Code Review 的參考

CodeReview 的內(nèi)容

[1]架構(gòu)/設(shè)計(jì)/常規(guī)?

1.單一職責(zé)原則 這是經(jīng)常被違背的原則。一個(gè)類只能干一個(gè)事情讶泰,一個(gè)方法最好也只干一件事情咏瑟。比較常見的違背是一個(gè)類既干UI的事情,又干邏輯的事情痪署,這個(gè)在低質(zhì)量的客戶端代碼里很常見?

2.行為是否統(tǒng)一码泞,例如:

????1)緩存是否統(tǒng)一

????2)錯(cuò)誤處理是否統(tǒng)一

????3)錯(cuò)誤提示是否統(tǒng)一

????4)彈出框是否統(tǒng)一

????5)……?

3.代碼污染 代碼有沒有對其他模塊強(qiáng)耦合?

4.重復(fù)代碼-->應(yīng)該抽取?

5.開閉原則?

6.面向接口編程?

7.健壯性

????1)是否考慮線程安全

????2)數(shù)據(jù)訪問是否一致性

????3)邊界處理是否完整

????4)邏輯是否健壯

????5)是否有內(nèi)存泄漏

????6)有沒有循環(huán)依賴

????7)有沒有野指針

????8)是否檢查了數(shù)組的“越界“錯(cuò)誤

????9)……?

8.錯(cuò)誤處理?

9.改動是不是對代碼的提升 新的改動是打補(bǔ)丁,讓代碼質(zhì)量繼續(xù)惡化狼犯,還是對代碼質(zhì)量做了修復(fù)?

10.效率/性能

????1)關(guān)鍵算法的時(shí)間復(fù)雜度多少余寥?有沒有可能有潛在的性能瓶頸

????2)客戶端程序?qū)︻l繁消息和較大數(shù)據(jù)等耗時(shí)操作是否處理得當(dāng)

[2]代碼風(fēng)格?

1.可讀性 衡量可讀性的可以有很好實(shí)踐的標(biāo)準(zhǔn),就是 Reviewer 能否非常容易的理解這個(gè)代碼悯森。如果不是宋舷,那意味著代碼的可讀性要進(jìn)行改進(jìn)?

2.命名?

????1)命名對可讀性非常重要?

????2)是否跟系統(tǒng)屬性命名造成沖突?

????3)英語用詞盡量準(zhǔn)確一點(diǎn),必要時(shí)可以查字典?

3.函數(shù)長度/類長度?

????1)函數(shù)太長的不好閱讀?

????2)類太長了瓢姻,檢查是否違反的 單一職責(zé) 原則?

4.注釋 恰到好處的注釋,不是注釋越多越好

5.參數(shù)個(gè)數(shù) 不要太多祝蝠,一般不要超過 3 個(gè)

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市汹来,隨后出現(xiàn)的幾起案子续膳,更是在濱河造成了極大的恐慌,老刑警劉巖收班,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件坟岔,死亡現(xiàn)場離奇詭異,居然都是意外死亡摔桦,警方通過查閱死者的電腦和手機(jī)社付,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來邻耕,“玉大人鸥咖,你說我怎么就攤上這事⌒质溃” “怎么了啼辣?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長御滩。 經(jīng)常有香客問我鸥拧,道長党远,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任富弦,我火速辦了婚禮沟娱,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘腕柜。我一直安慰自己济似,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布盏缤。 她就那樣靜靜地躺著砰蠢,像睡著了一般。 火紅的嫁衣襯著肌膚如雪唉铜。 梳的紋絲不亂的頭發(fā)上娩脾,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天,我揣著相機(jī)與錄音打毛,去河邊找鬼。 笑死俩功,一個(gè)胖子當(dāng)著我的面吹牛幻枉,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播诡蜓,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼熬甫,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蔓罚?” 一聲冷哼從身側(cè)響起椿肩,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎豺谈,沒想到半個(gè)月后郑象,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡茬末,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年厂榛,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片丽惭。...
    茶點(diǎn)故事閱讀 40,137評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡击奶,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出责掏,到底是詐尸還是另有隱情柜砾,我是刑警寧澤,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布换衬,位于F島的核電站痰驱,受9級特大地震影響证芭,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜萄唇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一檩帐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧另萤,春花似錦湃密、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至忿危,卻和暖如春达箍,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背铺厨。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工缎玫, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人解滓。 一個(gè)月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓赃磨,卻偏偏與公主長得像,于是被迫代替她去往敵國和親洼裤。 傳聞我的和親對象是個(gè)殘疾皇子邻辉,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,086評論 2 355

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

  • 什么是CodeReview CodeReview的目的是提升代碼質(zhì)量,盡早發(fā)現(xiàn)潛在缺陷與BUG腮鞍,降低修復(fù)成本值骇,同時(shí)...
    忠橙_g閱讀 25,358評論 0 32
  • 前言 很多公司都要求項(xiàng)目做CodeReview,但很多人第一次CodeReview往往不知道該如何做移国,也不知道為什...
    趙客縵胡纓v吳鉤霜雪明閱讀 23,196評論 2 24
  • 1.CodeReview最終的作用 促進(jìn)工程師日常代碼交流 人員成長 作為輔助手段對產(chǎn)品質(zhì)量進(jìn)行把關(guān)吱瘩。 另一種作用...
    JSleefat閱讀 280評論 0 0
  • 目標(biāo)和原則 提高代碼質(zhì)量,及早發(fā)現(xiàn)潛在缺陷迹缀,降低修改/彌補(bǔ)缺陷的成本 促進(jìn)團(tuán)隊(duì)內(nèi)部知識共享搅裙,提高團(tuán)隊(duì)整體水平 評審...
    編程產(chǎn)品人閱讀 58,292評論 5 75
  • 前言 沒實(shí)習(xí)之前,不怎么用到版本管理工具裹芝。頂多就是用Git把寫的一些代碼上傳到github上部逮,基本上不會涉及到某一...
    盡情的嘲笑我吧閱讀 483評論 0 2