Wednesday, April 20, 2011

[PHP] 語法檢查工具PHPCheckstyle

PHPCheckstyle是個用來檢查PHP程式碼語法是否符合標準的工具,本身亦是用PHP語言撰寫,它會將檢查的結果輸出成HTML格式的報表檔,因此需要用網頁瀏覽器去讀它產生的檔案。

PHPCheckstyle的官方網站為 http://code.google.com/p/phpcheckstyle/

下載和使用之前,先檢查自己的系統裡是否已經有PHP直譯器了,沒有的話就安裝一下。

Screenshot-usagi_suzu_ _

確認自己的環境有PHP直譯器之後,到PHPCheckstyle的官網下載主程式檔案並解壓縮。

Screenshot-PhpCheckstyle 0.9.1.zip - phpcheckstyle - PHPCheckstyle release 0.9.1 - Coding convention style checker for PHP - Google Project Hosting - Mozilla Firefox

Screenshot-usagi_suzu_ _-1

解壓縮後的檔案會像下圖這個樣子,run.php就是主程式,可用PHP直譯器執行它:

Screenshot-usagi_suzu_ _-PhpCheckstyle-1

最簡單的用法是「php run.php –src 要被檢查的檔案或目錄」:

Screenshot-usagi_suzu_ _-PhpCheckstyle-2

預設產生的報表檔案如下圖:

Screenshot-style-report

用瀏覽器開啟index.html就能看到檢查的結果了,可以依據檢查的結果去修正被檢查的檔案:

Screenshot

如果是檢查一整個目錄,結果會是如下圖這個樣子:

Screenshot-PHPCheckstyle Results - Mozilla Firefox

也可以直接將檢查後的結果直接在console輸出:

Screenshot-usagi_suzu_ _-PhpCheckstyle-3

PHPCheckstyle預設用PEAR的標準檢查程式碼,不過可以用設定檔的方式來修改檢查規則以符合專案或團隊的需要,設定檔是XML格式:

Screenshot-default.cfg.xml (~-PhpCheckstyle-config) - gedit

No comments:

Post a Comment