介紹幾個輕量級代碼檢查工具,包括代碼靜態檢查,整理代碼等。
無論是自己一個人寫代碼,還是與其他人合作寫代碼,都希望能有一份高質量的代碼,以便別人或未來的自己可讀、可維護和可擴展。
於是往往我們需要代碼評審(Code Review)。正式的代碼評審已經有不少書籍介紹且與開發環境有關,這裏只介紹幾個輕量級代碼檢查工具,方便日常開發過程中提高自己的代碼質量。
Python
Pylint
Pylint 是一個 Python 源代碼分析工具,可以分析代碼錯誤,查找不符合代碼風格標準(Pylint 默認使用的代碼風格是 PEP 8)和有潛在問題的代碼。
安裝:
pip install pylint
使用:
pylint 1.py
安裝直接用 pip 就可以了,使用則是輸入代碼文件路徑就可以了,它會輸出存在不同級別問題的代碼的所在位置,還能評分。更多的用法可以參考官方網站。
yapf
https://github.com/google/yapf
yapf 是一個 Google 開源的 Python 代碼格式化工具。可以格式化代碼,統一縮進、換行、符號等格式。
安裝:
pip install yapf
使用:
yapf 1.py > out.py
安裝直接用 pip 就可以了,使用則是輸入代碼文件路徑就可以了,它會輸出美化後的代碼,因此可以重定向至一個文件。更多的用法可以參考官方網站。
C++
cpplint
https://github.com/cpplint/cpplint
cpplint 是一個遵循 Google C++ 風格指南的 C++ 靜態代碼檢索工具。
安裝:
pip install cpplint
使用:
cpplint 1.cpp
安裝直接用 pip 就可以了,使用則是輸入代碼文件路徑就可以了,它會輸出存在不同級別問題的代碼的所在位置。更多的用法可以參考官方網站。
AStyle
http://astyle.sourceforge.net/
AStyle 即 Artistic Style,是一個支持 C, C++, C++/CLI,Objective‑C, C# 和 Java 的格式化工具。可以格式化代碼,統一縮進、換行、符號等格式。
注意 AStyle 風格與 Google C++ 風格不一樣。
安裝:
到 https://sourceforge.net/projects/astyle/ 點“Download”按鈕即可根據當前平臺下載相應安裝包,根據說明安裝即可。
使用:
astyle 1.cpp
使用則是輸入代碼文件路徑就可以了,它會輸出美化後的代碼,並把原代碼備份至 1.cpp.orig
。更多的用法可以參考官方網站。
Sublime 插件
以上工具均在 Sublime 中能找到插件,只需 Install Package 安裝即可。之後可在編碼時實現一鍵格式化或一鍵檢查。
SublimeLinter 裏包含各種語言的 linter。
PyYapf 是 Python yapf 格式化工具。
SublimeAStyleFomatter 是 C++ AStyle 格式化工具。