代碼檢視清單

代碼檢視時須要關注的內容

常規項
    代碼可以工做麼？它有沒有實現預期的功能，邏輯是否正確等。

    全部的代碼是否簡單易懂？

    代碼符合你所遵循的編程規範麼？這一般包括大括號的位置，變量名和函數名，行的長度，縮進，格式和註釋。

    是否存在多餘的或是重複的代碼？

    代碼是否儘量的模塊化了？

    是否有能夠被替換的全局變量？

    是否有被註釋掉的代碼？

    循環是否設置了長度和正確的終止條件？

    是否有能夠被庫函數替代的代碼？

    是否有能夠刪除的日誌或調試代碼？

安全

    全部的數據輸入是否都進行了檢查（檢測正確的類型，長度，格式和範圍）而且進行了編碼？

    在哪裏使用了第三方工具，返回的錯誤是否被捕獲？

    輸出的值是否進行了檢查而且編碼？

    無效的參數值是否可以處理？

文檔

    是否有註釋，而且描述了代碼的意圖？

    全部的函數都有註釋嗎？

    對很是規行爲和邊界狀況處理是否有描述？

    第三方庫的使用和函數是否有文檔？

    數據結構和計量單位是否進行了解釋？

    是否有未完成的代碼？若是是的話，是否是應該移除，或者用合適的標記進行標記好比‘TODO’？

測試

    代碼是否能夠測試？好比，不要添加太多的或是隱藏的依賴關係，不可以初始化對象，測試框架能夠使用方法等。

    是否存在測試，它們是否能夠被理解？好比，至少達到你滿意的代碼覆蓋(code coverage)。

    單元測試是否真正的測試了代碼是否能夠完成預期的功能？

    是否檢查了數組的「越界「錯誤？

    是否有能夠被已經存在的API所替代的測試代碼？