代碼審查清單

常規(guī)項(xiàng)

代碼能夠工作么伸但?它有沒(méi)有實(shí)現(xiàn)預(yù)期的功能肾请,邏輯是否正確等。

所有的代碼是否簡(jiǎn)單易懂更胖?

代碼符合你所遵循的編程規(guī)范么铛铁?這通常包括大括號(hào)的位置,變量名和函數(shù)名却妨,行的長(zhǎng)度饵逐,縮進(jìn),格式和注釋彪标。

是否存在多余的或是重復(fù)的代碼倍权?

代碼是否盡可能的模塊化了?

是否有可以被替換的全局變量捞烟?

是否有被注釋掉的代碼薄声?

循環(huán)是否設(shè)置了長(zhǎng)度和正確的終止條件?

是否有可以被庫(kù)函數(shù)替代的代碼题画?

是否有可以刪除的日志或調(diào)試代碼默辨?

安全

所有的數(shù)據(jù)輸入是否都進(jìn)行了檢查(檢測(cè)正確的類型,長(zhǎng)度苍息,格式和范圍)并且進(jìn)行了編碼缩幸?

在哪里使用了第三方工具,返回的錯(cuò)誤是否被捕獲档叔?

輸出的值是否進(jìn)行了檢查并且編碼桌粉?

無(wú)效的參數(shù)值是否能夠處理?

文檔

是否有注釋衙四,并且描述了代碼的意圖铃肯?

所有的函數(shù)都有注釋嗎?

對(duì)非常規(guī)行為和邊界情況處理是否有描述传蹈?

第三方庫(kù)的使用和函數(shù)是否有文檔押逼?

數(shù)據(jù)結(jié)構(gòu)和計(jì)量單位是否進(jìn)行了解釋?

是否有未完成的代碼惦界?如果是的話挑格,是不是應(yīng)該移除,或者用合適的標(biāo)記進(jìn)行標(biāo)記比如‘TODO’沾歪?

測(cè)試

代碼是否可以測(cè)試漂彤?比如,不要添加太多的或是隱藏的依賴關(guān)系,不能夠初始化對(duì)象挫望,測(cè)試框架可以使用方法等立润。

是否存在測(cè)試,它們是否可以被理解媳板?比如桑腮,至少達(dá)到你滿意的代碼覆蓋(code coverage)。

單元測(cè)試是否真正的測(cè)試了代碼是否可以完成預(yù)期的功能蛉幸?

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

是否有可以被已經(jīng)存在的API所替代的測(cè)試代碼?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末奕纫,一起剝皮案震驚了整個(gè)濱河市提陶,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌匹层,老刑警劉巖搁骑,帶你破解...
    沈念sama閱讀 218,386評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異又固,居然都是意外死亡仲器,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,142評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén)仰冠,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)乏冀,“玉大人,你說(shuō)我怎么就攤上這事洋只×韭伲” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,704評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵识虚,是天一觀的道長(zhǎng)肢扯。 經(jīng)常有香客問(wèn)我,道長(zhǎng)担锤,這世上最難降的妖魔是什么蔚晨? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,702評(píng)論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮肛循,結(jié)果婚禮上铭腕,老公的妹妹穿的比我還像新娘。我一直安慰自己多糠,他們只是感情好累舷,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,716評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著夹孔,像睡著了一般被盈。 火紅的嫁衣襯著肌膚如雪析孽。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,573評(píng)論 1 305
  • 那天只怎,我揣著相機(jī)與錄音绿淋,去河邊找鬼。 笑死尝盼,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的佑菩。 我是一名探鬼主播盾沫,決...
    沈念sama閱讀 40,314評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼殿漠!你這毒婦竟也來(lái)了赴精?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,230評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤绞幌,失蹤者是張志新(化名)和其女友劉穎蕾哟,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體莲蜘,經(jīng)...
    沈念sama閱讀 45,680評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡谭确,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,873評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了票渠。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片逐哈。...
    茶點(diǎn)故事閱讀 39,991評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖问顷,靈堂內(nèi)的尸體忽然破棺而出昂秃,到底是詐尸還是另有隱情,我是刑警寧澤杜窄,帶...
    沈念sama閱讀 35,706評(píng)論 5 346
  • 正文 年R本政府宣布肠骆,位于F島的核電站,受9級(jí)特大地震影響塞耕,放射性物質(zhì)發(fā)生泄漏蚀腿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,329評(píng)論 3 330
  • 文/蒙蒙 一扫外、第九天 我趴在偏房一處隱蔽的房頂上張望唯咬。 院中可真熱鬧,春花似錦畏浆、人聲如沸胆胰。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,910評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)蜀涨。三九已至瞎嬉,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間厚柳,已是汗流浹背氧枣。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,038評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留别垮,地道東北人便监。 一個(gè)月前我還...
    沈念sama閱讀 48,158評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像碳想,于是被迫代替她去往敵國(guó)和親烧董。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,941評(píng)論 2 355

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

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理胧奔,服務(wù)發(fā)現(xiàn)逊移,斷路器,智...
    卡卡羅2017閱讀 134,657評(píng)論 18 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,140評(píng)論 25 707
  • ①香蔥芋艿 材料:芋頭龙填、食鹽胳泉、小蔥、水岩遗、白糖扇商、植物油。 做法: 1宿礁、芋頭連皮洗凈钳吟,放入鍋中加水蓋過(guò),煮滾后轉(zhuǎn)小火煮...
    享受幸福1閱讀 433評(píng)論 0 2
  • 小處不慎漏窘拯,暗處不欺隱红且,末路不怠慌。 當(dāng)怒火預(yù)水正騰沸時(shí)涤姊,明明知得暇番,又明明犯著。知得是誰(shuí)思喊,犯著又是誰(shuí)壁酬,此處能猛然轉(zhuǎn)...
    HedyWang1閱讀 114評(píng)論 0 0
  • 今天正式第一天跟航宇一起練習(xí)舞蹈,沒(méi)有多辛苦恨课,玩玩鬧鬧的舆乔,但是舞蹈的動(dòng)作卻弄得我們焦頭爛額,沒(méi)有頭緒剂公,一點(diǎn)點(diǎn)的學(xué)習(xí)...
    姜雷_24b1閱讀 103評(píng)論 0 0