Code Review(代碼審查)-推薦

Code Review是什么?

Code Review是一種用來確認方案設計和代碼實現的質量保證機制,通過這個機制我們可以對代碼、測試過程和注釋進行檢查。

Code Review主要用來在軟件工程過程中改進代碼質量,通過Code Review可以達到, 在項目早期就能夠發現代碼中的BUG。

Code Review 主要 Revivew 什么?

代碼設計/構思方面:

1、單一職責原則(SRP)

這是經常被違背的原則。一個類只能干一個事情 , 一個方法最好也只干一件事情。 比較常見的違背是一個類既干 UI 的事情,又干邏輯的事情 , 這個在低質量的客戶端代碼里很常見。

2、行為是否統一

1.比如緩存是否統一,錯誤處理是否統一, 錯誤提示是否統一, 彈出框是否統一 等等。

2.同一邏輯 / 同一行為 有沒有走同一 Code Path?

3、代碼污染

代碼有沒有對其他模塊強耦合 ?

4、重復代碼

主要看有沒有把公用組件,可復用的代碼,函數抽取出來。

5、開放封閉原則(OCP)

就是好不好擴展。 Open for extension, closed for modification.

6、接口隔離原則(ISP)

使用多個隔離的接口,比使用單個接口要好。

7、面向接口編程 和 不是 面向實現編程

主要就是看有沒有進行合適的抽象, 把一些行為抽象為接口。

8、健壯性

1.對 Corner case 有沒有考慮完整,邏輯是否健壯?有沒有潛在的 bug?

2.有沒有內存泄漏?有沒有循環依賴 ?(針對特定語言,比如 Objective-C) ?有沒有野指針?

3.有沒有考慮線程安全性, 數據訪問的一致性

9、錯誤處理

有沒有很好的 Error Handling?比如網絡出錯,IO 出錯。

10、改動是不是對代碼的提升

新的改動是讓代碼質量繼續惡化,還是對代碼質量做了修復?

11、效率 / 性能

1.客戶端程序 對頻繁消息 和較大數據等耗時操作是否處理得當。

2.關鍵算法的時間復雜度多少?有沒有可能有潛在的性能瓶頸。

12、可讀性 / 可維護性

1.字段、變量、參數、方法、類的命名是否合理。

2.字段、變量、參數、方法、類的注釋是否完整。


如何進行Code Review?

1.多問問題。多問 “這塊兒是怎么工作的?” “如果有 XXX case,你這個怎么處理?”

2.每次提交的代碼不要太多,最好不要超過 1000 行,否則 review 起來效率會非常低。

3.當面討論代替 Comments。 大部分情況下小組內的同事是坐在一起的,face to face 的 code review 是非常有效的。

4.區分重點,不要舍本逐末。 優先抓住設計,可讀性,健壯性等重點問題。

Code Review應該注意什么?

1.作為審查者:代碼審查是一種學習,是表揚,是獲得反饋,是一種十分社交性的活動。代碼審查應該是有趣的,不要讓它變的無聊。

2.作為開發人員:代碼審查是針對代碼,不是針對你。不要把代碼審查當成互相諷刺的論壇和相互批判的工具。反而,代碼審查是提高你的一種路徑。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,578評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,701評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,691評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,974評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,694評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,026評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,015評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,193評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,719評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,442評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,668評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,151評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,846評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,255評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,592評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,394評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,635評論 2 380

推薦閱讀更多精彩內容

  • AtWiredrive, we do a fair amount of code reviews. I had n...
    civic星星之火閱讀 1,194評論 0 3
  • error code(錯誤代碼)=0是操作成功完成。error code(錯誤代碼)=1是功能錯誤。error c...
    Heikki_閱讀 3,422評論 1 9
  • 今天是我的生日,除了老媽大清早發微信祝福我生日快樂,其他的孩子啊老公啊朋友啊,似乎沒有一個能想得起今天是我的生日,...
    月亮上的洋蔥閱讀 377評論 0 0
  • 中秋第二天。桐桐感冒在家,咳嗽嘔吐,很不舒服也很焦躁地一直哭。晚上開著車帶著她到處找藥,婁底這小地方卻沒有猴耳環消...
    赫墨思閱讀 121評論 0 0
  • 1.別去找截圖的方法了,直接將UIView對象轉成圖片就完事了 分享自己搞去
    biyu6閱讀 1,201評論 0 1