提高代碼質量——來看代碼審查清單

2016-12-02 1519 0 編輯:網站設計美術楊瑩 來源:網站設計書籍

不管是網站開發,還是軟件開發,都是靠代碼編程一步一步搭建的,代碼質量的要求必須高。程序員常用代碼審查的手段去提高代碼質量,其實現在有很多的代碼審查技術,網絡上也也流傳了很多關于如何優化代碼的技術攻略,但這其中良莠不齊,今天深正互聯給大家列了一份代碼審查清單,梳理了適用于大多數語言的代碼審查點,希望可以為程序員小伙伴快速有效地審查代碼提供幫助。

代碼審查的目的

代碼審查的最終目的是找出代碼的薄弱點和優勢,然后揚長避短,找出合適的方法優化代碼以獲得更好的性能。 它主要是提供一個無缺陷(至少接近完美)的應用程序,以滿足企業要求,并同時滿足行業標準。

代碼審查清單

1. 實現企業要求

代碼能夠滿足企業要求這是基本的要求。

2.牢不可破,合理驗證

驗證是很必要的。代碼在任何情況下都不會中斷,所以在遇到來自用戶端的無效輸入的也不會中斷,否定的、過大的或者無效的格式輸入應該在進一步處理之前就清理完成,在訪問之前,應該要檢查每個對象的實際數據是否合理。

3.處理響應

不應只是對服務器返回的錯誤消息進行處理,服務器返回的所有響應都應該處理,而且它還應該具有標題,響應消息,錯誤代碼以及任何其他必要的細節。在測試時要盡量全面的考慮到所有情況,來避免死鎖,超時等情況。

4. 結構設計,無設計偏差

應用軟件設計與功能實現說明文檔是程序設計首要做的工作,代碼的編寫一定要嚴格遵循此文檔,如果出現任何設計更改的情況,那么在現有代碼實現之前,就要對其進行記錄和標準化。

5. 單元測試可靠

每個核心方法都要經過單元測試,確保這些方法都是可用的。

6. 避免代碼重復

在代碼實現的過程中,程序中很可能會出現需要實現相同功能的部分,這時,我們可以考慮把這些相同代碼寫成函數,然后直接調用,避免代碼重復。

7. 快速響應和可擴展性

應用程序的響應應該是快速的:請求和響應之間沒有長時間的延遲、避免原始字符串連接;代碼是可擴展的,能夠處理大量的數據和未來可能需要添加的功能。

8.代碼安全

確保代碼在加密認證、角色、未經授權的訪問、目錄瀏覽、SQL注入、跨腳本等方面是安全的,并遵循OWASP安全原則。

9.可管理

代碼可讀性強,有適當的注釋且易于管理,方法的大小不超過可讀范圍。

10.標準化方法

遵循編碼慣例和標準,與現有的應用程序代碼是一致的,并且不應該存在已被注釋了的代碼和硬編碼。

11.內存處理

在使用結束后未自動釋放的資源將被釋放。連接,端口正確關閉。

12.可追溯性

記錄每筆交易或需要記錄的日志,然后存儲在存儲庫(作為文件)以及數據庫(作為文本)中。可以在配置文件(例如web.config)中啟用或禁用不同階段的版本。

13.代碼覆蓋率大于95%

代碼覆蓋與單元測試用例一樣重要。 95%的代碼被覆蓋意味著95%的代碼實際上是通過單元測試用例測試的。

14.快速

僅提供需求就可以方便的獲取資源,必要時可以處理龐大的數據,如分頁等。

15.數據安全

運行應用程序時不會出現編譯器警告。清除開發過程中使用的日志,并且不會在瀏覽器控制臺中寫入任何應用程序信息,特別是敏感的信息。

16.第三方工具許可

在必要時應用程序可能會使用外部庫,如果它是第三方工具,那么它的許可證和法律用途必須合規。

高質量的代碼不僅可以完全滿足用戶的要求,同時它在可擴展性和快速響應方面也應該表現出色。在這個各種追求速度的糙快猛創業公司遍地的世界,如果你能真正的沉下心來寫好代碼,脫穎而出指日可待。

高端網站建設

本站文章均為深正網站建設摘自權威資料,書籍,或網絡原創文章,如有版權糾紛或者違規問題,請即刻聯系我們刪除,我們歡迎您分享,引用和轉載,但謝絕直接搬磚和抄襲!感謝...
關注深正互聯
七星彩头尾