PHP工具篇:PHPStorm IDE使用CodeSniffer代碼規范化管理

Jonathan Shieber 發布于2019-07-01 11:04 / 2129人閱讀

摘要：使用進行代碼規范化管理是一個優秀的代碼風格檢測工具定義了一系列的代碼規范通常使用官方的代碼規范標準，比如的能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級常被用作團隊開發時維護編碼風格以及標準。

PHPStorm IDE使用CodeSniffer進行代碼規范化管理

PHP_CodeSniffer是一個優秀的代碼風格檢測工具,定義了一系列的代碼規范(通常使用官方的代碼規范標準，比如PHP的PSR2),能夠檢測出不符合代碼規范的代碼并發出警告或報錯(可設置報錯等級),常被用作團隊開發時維護編碼風格以及標準。

安裝

mac安裝:

brew install php-code-sniffer
//檢測安裝是否成功
phpcs --h
//安裝完成后的路徑
/usr/local/Cellar/php-code-sniffer

phpcs的配置

查看詳細配置。使用命令:phpcs --config-show

設置默認的編碼標準。（這個很重要，建議使用 PSR2 的標準)

# 查看配置
$ phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz and Zend

# 設置編碼標準為 PSR2
$ phpcs --config-set default_standard PSR2

隱藏警告。（當然，對于強迫癥來說，警告都是不允許的，非強迫癥患者可以使用此配置項）

# 隱藏警告提醒
$ phpcs --config-set show_warnings 0
# 開啟警告提醒
$ phpcs --config-set show_warnings 1

顯示檢查進程。（如果項目需要檢查的文件較多可以開啟這個）

# 顯示檢查進程
$ phpcs --config-set show_progress 1
# 關閉進程顯示
$ phpcs --config-set show_progress 0

顯示顏色

# 顯示顏色
$ phpcs --config-set colors 1
# 關閉顏色顯示
$ phpcs --config-set colors 0

修改錯誤和警告等級

# 顯示所有的錯誤和警告
$ phpcs --config-set severity 1
# 顯示所有的錯誤，部分警告 注意等級可有從 5-8 5 的警告顯示會更多，8 的更少
$ phpcs --config-set severity 1
$ phpcs --config-set warning_severity 5

設置默認編碼

# 設置 utf-8
$ phpcs --config-set encoding utf-8

設置 tab 的寬度

# tab 為 4 個空格
$ phpcs --config-set tab_width 4
# 也可以對多帶帶文件生效
$ phpcs --tab-width=0 /path/to/code

代碼驗證

# 校驗單個文件
$ phpcs filename
＃ 校驗目錄 注意這個時候別因為 linux 學的太好加個 -R 哈。
$ phpcs /path/dir

代碼規范檢測,命令行使用

$ phpcs /home/www/init.php
FILE: /home/www/init.php
-------------------------------------------------------------
FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
-------------------------------------------------------------
  1 | ERROR | Extra newline found after the open tag
 13 | ERROR | Missing function doc comment
-------------------------------------------------------------

設置PHPStorm整合CodeSniffer

配置 Code Sniffer

在 “Preferences”->“Languages & Frameworks”->“PHP”->“Quality Tools” ->“Code Sniffer” 配置中，“Configuration” 項后點擊...并輸入 phpcs 路徑，可以使用 “Validate” 按鈕驗證phpcs路徑是否正確。

開啟驗證

在 “Preferences”->“Editor”->“Inspections”->“Quality Tools”配置中，勾選上 “PHP Code Sniffer validation”。

具體參數中,
Show warnings as: Warnning，標示提示級別
Coding standard PSR2 代表執行的規范如果找不到這個選項，點一下緊挨著的刷新按鈕。

更多精彩內容，請關注作者博客，https://studytime.xin

云服務器 GPU云服務器 PHP_CodeSniffer 本地代碼管理工具 js ide 工具 ide開發工具

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/29808.html

PHP 規范說明與工具

摘要：今天這篇分享將簡單地梳理一下規范，并介紹一個代碼檢查工具，結合以及進行實踐。目前流行的一些規范是的簡寫，由組織制定的規范，是開發的實踐標準。目前已表決通過了套標準，已經得到大部分框架的支持和認可。 > 作為一個新手，寫出規范的代碼也是一門必修課，除了閱讀相應的代碼規范文檔之外，充分利用相關的工具能使得進階之路事半功倍。今天這篇分享將簡單地梳理一下 PHP 規范，并介紹一個代碼檢查工具 ...

snowLu 2019-06-28 13:49 評論0 收藏0
看吧，這就是現代化 PHP 該有的樣子

摘要：這大概是我沒有及早使用，或多數開發者流連現狀造成的。它就是，一個的框架。行為驅動開發是來自測試驅動開發的開發過程。簡單的說，它就是經?？赡芤惶鞄状螌⑿K代碼整合進基礎代碼當中的行為。 showImg(https://segmentfault.com/img/remote/1460000013769815); 這是一篇社區協同翻譯的文章，已完成翻譯，更多信息請點擊?協同翻譯介紹?。文章...

Tangpj 2019-06-28 18:33 評論0 收藏0
PHP代碼修正之CodeSniffer

摘要：它包含兩類腳本，和地址腳本對文件定義了一系列的代碼規范通常使用官方的代碼規范標準，比如的，能夠檢測出不符合代碼規范的代碼并發出警告或報錯可設置報錯等級。腳本能自動修正代碼格式上不符合規范的部分。 Last-Modified: 2019年5月10日13:59:27 參考鏈接 PHP開發規范之使用phpcbf腳本自動修正代碼格式在PhpStorm中使用PSR2編碼規范phpcbf腳本自...

khs1994 2019-07-01 12:45 評論0 收藏0
PHP IDE eclipse-php-luna 使用規范

摘要：前言根據調查大部分個人開發者會選擇免費的基本上是和之爭。團隊協作時，初期還是需要有一個指導性質的工具規范，養成一至的代碼風格?？紤]用戶較多，以下截圖取自平臺，平臺基本一樣。在統一編碼習慣和風格后，并不限制編輯器。 PHP IDE eclipse-php-luna 前言根據http://www.sitepoint.com/best-php-ide-2014-survey-resul...

mgckid 2019-06-27 10:59 評論0 收藏0
使用PHPCS+GIT鉤子保障團隊開發中代碼風格一致性實踐

摘要：集成經過上面的操作，代碼格式化的規則基本與的規則基本一致了，但也有一小部分不一致，所以后面還要用到和。一、背景筆者在6月份加入新團隊，新團隊這邊剛組建起來，基礎一些東西還處于待完善狀態，比如筆者組內同學約定使用PSR-2的編碼風格規范，但是并不是所有人都嚴格按照PSR-2來提交代碼。最大的原因就是口頭的約束力極為有限，而團隊中大家使用的編輯器不統一，有使用phpstorm，也有使...

wums 2019-07-01 10:28 評論0 收藏0