代碼審查(Code Review)

轉(zhuǎn)至:
http://blog.jobbole.com/83595/

代碼審查清單

常規(guī)項
代碼能夠工作么滋恬?它有沒有實現(xiàn)預(yù)期的功能麦到,邏輯是否正確等绪钥。
所有的代碼是否簡單易懂哩掺?
代碼符合你所遵循的編程規(guī)范么检眯?這通常包括大括號的位置厘擂,變量名和函數(shù)名,行的長度锰瘸,縮進刽严,格式和注釋。
是否存在多余的或是重復(fù)的代碼?
代碼是否盡可能的模塊化了舞萄?
是否有可以被替換的全局變量眨补?
是否有被注釋掉的代碼?
循環(huán)是否設(shè)置了長度和正確的終止條件倒脓?
是否有可以被庫函數(shù)替代的代碼撑螺?
是否有可以刪除的日志或調(diào)試代碼?

安全
所有的數(shù)據(jù)輸入是否都進行了檢查(檢測正確的類型崎弃,長度甘晤,格式和范圍)并且進行了編碼?
在哪里使用了第三方工具饲做,返回的錯誤是否被捕獲线婚?
輸出的值是否進行了檢查并且編碼?
無效的參數(shù)值是否能夠處理盆均?

文檔
是否有注釋塞弊,并且描述了代碼的意圖?
所有的函數(shù)都有注釋嗎泪姨?
對非常規(guī)行為和邊界情況處理是否有描述游沿?
第三方庫的使用和函數(shù)是否有文檔?
數(shù)據(jù)結(jié)構(gòu)和計量單位是否進行了解釋肮砾?
是否有未完成的代碼奏候?如果是的話,是不是應(yīng)該移除唇敞,或者用合適的標(biāo)記進行標(biāo)記比如‘TODO’蔗草?

測試
代碼是否可以測試?比如疆柔,不要添加太多的或是隱藏的依賴關(guān)系咒精,不能夠初始化對象,測試框架可以使用方法等旷档。
是否存在測試模叙,它們是否可以被理解?比如鞋屈,至少達(dá)到你滿意的代碼覆蓋(code coverage)范咨。
單元測試是否真正的測試了代碼是否可以完成預(yù)期的功能?
是否檢查了數(shù)組的“越界“錯誤厂庇?
是否有可以被已經(jīng)存在的API所替代的測試代碼渠啊?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市权旷,隨后出現(xiàn)的幾起案子替蛉,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,110評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件躲查,死亡現(xiàn)場離奇詭異它浅,居然都是意外死亡,警方通過查閱死者的電腦和手機镣煮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,443評論 3 395
  • 文/潘曉璐 我一進店門姐霍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人典唇,你說我怎么就攤上這事镊折。” “怎么了蚓聘?”我有些...
    開封第一講書人閱讀 165,474評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長盟劫。 經(jīng)常有香客問我夜牡,道長,這世上最難降的妖魔是什么侣签? 我笑而不...
    開封第一講書人閱讀 58,881評論 1 295
  • 正文 為了忘掉前任塘装,我火速辦了婚禮,結(jié)果婚禮上影所,老公的妹妹穿的比我還像新娘蹦肴。我一直安慰自己,他們只是感情好猴娩,可當(dāng)我...
    茶點故事閱讀 67,902評論 6 392
  • 文/花漫 我一把揭開白布阴幌。 她就那樣靜靜地躺著,像睡著了一般卷中。 火紅的嫁衣襯著肌膚如雪矛双。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,698評論 1 305
  • 那天蟆豫,我揣著相機與錄音议忽,去河邊找鬼。 笑死十减,一個胖子當(dāng)著我的面吹牛栈幸,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播帮辟,決...
    沈念sama閱讀 40,418評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼速址,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了由驹?” 一聲冷哼從身側(cè)響起壳繁,我...
    開封第一講書人閱讀 39,332評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后闹炉,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蒿赢,經(jīng)...
    沈念sama閱讀 45,796評論 1 316
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,968評論 3 337
  • 正文 我和宋清朗相戀三年渣触,在試婚紗的時候發(fā)現(xiàn)自己被綠了羡棵。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,110評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡嗅钻,死狀恐怖皂冰,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情养篓,我是刑警寧澤秃流,帶...
    沈念sama閱讀 35,792評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站柳弄,受9級特大地震影響舶胀,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜碧注,卻給世界環(huán)境...
    茶點故事閱讀 41,455評論 3 331
  • 文/蒙蒙 一嚣伐、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧萍丐,春花似錦轩端、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,003評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至壳影,卻和暖如春耿导,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背态贤。 一陣腳步聲響...
    開封第一講書人閱讀 33,130評論 1 272
  • 我被黑心中介騙來泰國打工舱呻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人悠汽。 一個月前我還...
    沈念sama閱讀 48,348評論 3 373
  • 正文 我出身青樓箱吕,卻偏偏與公主長得像,于是被迫代替她去往敵國和親柿冲。 傳聞我的和親對象是個殘疾皇子茬高,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,047評論 2 355

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

  • (轉(zhuǎn))代碼審查(Code Review)清單在我們關(guān)于高效代碼審查的博文中,我們建議使用一個檢查清單假抄。在代碼審查中...
    一個就夠啦閱讀 419評論 0 2
  • 在我們關(guān)于高效代碼審查的博文中怎栽,我們建議使用一個檢查清單丽猬。在代碼審查中,檢查清單是一個非常好的工具——它們保證了審...
    i云哲閱讀 564評論 0 1
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理熏瞄,服務(wù)發(fā)現(xiàn)脚祟,斷路器,智...
    卡卡羅2017閱讀 134,662評論 18 139
  • 我們終此一生强饮,就是要擺脫他人的期待由桌,找到真正的自己。 在我看來邮丰,《無聲的告白》是一本講述親子關(guān)系教育的書行您。文中16...
    藍(lán)雪依夢閱讀 270評論 0 1
  • 小樹同桌進小進 打卡12/30
    魯班木閱讀 111評論 0 0