代碼評審技術
代碼審查(Code Review)是一種用來確認方案設計和代碼實現的質量保證機制,它通過閱讀代碼來檢查源代碼與編碼規范的符合性以及代碼的質量。
代碼審查的作用
- 檢查設計的合理性
- 互為 Backup
- 分享知識、設計、技術
- 增加代碼可讀性
- 處理代碼中的“地雷區”
缺陷檢查表
Python代碼分析工具
Pylint 是一個 Python 代碼分析工具,它用於分析 Python 代碼的錯誤,查找不符合代碼風格標准(Pylint 默認使用的代碼風格是 PEP 8)和有潛在問題的代碼。
Pylint功能
- 檢查代碼風格是否符合PEP8規范
- 檢查代碼是否存在常見的錯誤和違反最佳實踐
- 檢查重復的代碼
Pylint 安裝與使用
Pylint 安裝:
pip install -U pylint # 安裝最新版的Pylint
Pylint 使用:
pylint [op0ons] module_or_package_or_file # 對模塊/包/文件運行pylint
--rcfile= 指定檢查的配置文件
--ignore= 不進行檢查的文件列表
--disable= 關閉某種類型的檢查
-f 報告類型, 如html
代碼靜態分析工具
- Checkstyle:通過對代碼編碼格式、命名約定、Javadoc、類設計等方面進行代碼規范和風格的檢查。
- FindBugs:通過檢查類文件或JAR文件,將字節碼與一組缺陷模式進行對比從而發現代碼缺陷,完成靜態代碼分析。
- PMD:通過其內置的編碼規則對Java代碼進行靜態檢查,主要包括對潛在的Bug、未使用的代碼、重復的代碼、循環體創建新對象等問題的檢驗。
-
Jtest:能夠按照其內置的超過800條的Java編碼規范自動檢查並糾正這些隱蔽且難以修復的編碼錯誤,同時還支持用戶自定義編碼規則,幫助用戶預防一些特殊用法的錯誤。
-
微軟Visual Studio中的代碼分析工具可以檢查代碼中是否存在一些常見缺陷和違反良好編程習慣的情況。
- 微軟Visual Studio中的代碼分析工具可以檢查代碼中是否存在一些常見缺陷和違反良好編程習慣的情況。
- JSHint(www.jshint.com)是一款JavaScript代碼驗證工具,用於檢測代碼中的錯誤和潛在問題。
- CSSLint(csslint.net)是一款CSS代碼檢查工具,可以進行基本語法檢查以及使用一套預設的規則來檢查代碼中的問題。
- HTMLHint(htmlhint.com)是一款基於JS開發的靜態掃描組件,支持所有瀏覽器和Nodejs平台,可集成到IDE環境或編譯系統中。