我們寫代碼要遵循一定的規范, 但是我們有時候會犯錯,所以需要有一個檢查機制。當我們犯錯的時候檢查機制會發揮作用。下面我介紹一下如何在phpstrom上設置代碼檢查。
代碼規范
php有很多規范,我遵循的是PSR規范。PSR是PHP通用性框架小組FIG(PHP Framework Interop Group) 制定的PHP規范,是PHP開發的事實標准。關於PSR的中文文檔,可以參考https://github.com/PizzaLiu/PHP-FIG
讓phpstrom支持基於PSR2的代碼檢查的步驟
環境: windows操作系統 phpstrom版本10.0.2
安裝phpcs
使用composer全局安裝
修改 composer 的全局配置文件(推薦方式)
打開命令行窗口(windows用戶)或控制台(Linux、Mac 用戶)並執行如下命令:
composer config -g repo.packagist composer https://packagist.phpcomposer.com composer global require "squizlabs/php_codesniffer=*"
注:windows系統,會在
C:\Users\{user name}\AppData\Roaming\Composer\vendor\bin
下生成一個phpcs.bat文件,這個是phpstorm后續設置需要用到的文件
phpstorm設置
-
步驟1:打開phpstorm點擊 File->Settings
-
步驟2:接着點擊Languages & Frameworks->PHP->Code Sniffer點擊Configuration右側的按鈕,
-
步驟3:選擇PHP Code Sniffer (phpcs) path:的路徑,就是剛才composer之后生成的那個phpcs.bat的路徑。
-
步驟4:選擇之后點擊Validate驗證成功
-
步驟5:節點點擊Editor->Inspections展開點擊右側的PHP
-
步驟6:勾選PHP Code Sniffer Validation 選擇右側的PSR2
-
步驟7:點擊驗證成功 大功告成!!
-
看看效果吧,當寫的代碼不符合PSR2規范的時候該行代碼下會有波浪線,點擊波浪線可以查看提示信息
以上是phpstorm配置代碼檢查工具的通用步驟,我是基於windows的環境用的phpstorm10.0.2的版本,不同的版本可能設置上會有差異。在linux/mac環境下的步驟是一樣的,區別就在步驟3中選擇phpcs文件的路徑不同,還有就是windows下是用的phpcs.bat文件,linux/mac下是phpcs文件