您的位置:首页 > Web前端

phpstorm 配置 PHP_CodeSniffer

2017-11-30 21:21 609 查看
文章内容:
安装pear, 

pear安装PHP_CodeSniffer,
phpstorm配置codesniffer,
phpstorm汉化,
phpstorm汉化包。


为什么使用PHP_CodeSniffer

一个开发团队统一的编码风格,有助于他人对代码的理解和维护,对于大项目来说尤其重要。
PHP_CodeSniffer是PEAR中的一个用PHP5写的用来检查嗅探PHP代码是否有违反一组预先设置好的编码标准的一个包,它是确保你的代码简洁一致的必不可少的开发工具,甚至还可以帮助程序员减少一些语义错误。

什么是Pear

由于PHP_CodeSniffer的安装依赖PHP和Pear环境,那么我们有必要了解下什么是Pear。
来自百度百科:
PEAR是PHP扩展与应用库(the PHP Extension and Application Repository)的缩写。它是一个PHP扩展及应用的一个代码仓库,简单地说,PEAR之于PHP就像是CPAN(Comprehensive Perl Archive Network)之于Perl。PEAR的基本目标是发展成为PHP扩展和库代码的知识库,而这个项目最有雄心的目标则是试图定义一种标准,这种标准将帮助开发者编写可移植、可重用的代码。

安装Pear

在已经安装了PHP环境的前提下,进入php目录,如果没有go-pear.php文件,就鼠标右键点击这个链接:http://pear.php.net/go-pear.phar       鼠标右键将链接另存为文件(不要打开页面复制,不可用),然后放到你本机的php目录下 比如我用的wampserver 安装到D盘 我 就放到D:\application_work\wamp64\bin\php\php5.6.25  这里面了

使用管理员方式打开cmd命令行,输入以下命令:
1 cd application_work\wamp64\bin\php\php5.6.25 (你的php.exe所在目录)
2 php go-pear.phar
 
这时出现:(如果出现报错意思是不得大于100M ,就重新保存一下上面的那个链接文件,不要打开链接复制,打开链接复制是不可用的)
1 Are you installing a system-wide PEAR or a local copy?
2 (system|local) [system] :
 
直接回车默认system继续,出现如下:

1 Below is a suggested file layout for your new PEAR installation.  To
2 change individual locations, type the number in front of the
3 directory.  Type 'all' to change all of them or simply press Enter to
4 accept these locations.
5
6  1. Installation base ($prefix)                   : C:\php
7  2. Temporary directory for processing            : C:\php\tmp
8  3. Temporary directory for downloads             : C:\php\tmp
9  4. Binaries directory                            : C:\php
10  5. PHP code directory ($php_dir)                 : C:\php\pear
11  6. Documentation directory                       : C:\php\docs
12  7. Data directory                                : C:\php\data
13  8. User-modifiable configuration files directory : C:\php\cfg
14  9. Public Web Files directory                    : C:\php\www
15 10. System manual pages directory                 : C:\php\man
16 11. Tests directory                               : C:\php\tests
17 12. Name of configuration file                    : C:\WINDOWS\pear.ini
18 13. Path to CLI php.exe                           : C:\php
19
20 1-13, 'all' or Enter to continue:

 
直接回车,出现如下,表示安装成功,
/*省略*/
The 'pear' command is now at your service at c:\php\pear.bat
/*省略*/



PEAR_Config::writeConfigFile fopen(‘C:\Windows\pear.ini','w') failed (fopen(C:\Windows\pear.ini): failed to open stream: Permission denied)
如果出现这个错误就重新安装 选择 local 然后按提示输入,最后即可成功安装。





然后在你的php根目录下



双击pear.bat文件,注册pear到当前环境。

安装PHP_CodeSniffer

在安装完pear之后,就可以安装php_CodeSniffer了,继续在cmd中输入:
1 pear install PHP_CodeSniffer
等待安装完成,安装完成后php根目录下回出现以下两个文件:



按照下图依次打开文件夹,在看如下目录结构:



在php->pear->PHP->CodeSniffer->Standards中可以看到一些php的规范,Generic是通用规范。
现在我们就可以使用这些规范来检测我们的php代码了。

安装CodeIgniter标准(这一步可略,可以不安装,推荐用PSR2)

https://github.com/thomas-ernest/CodeIgniter-for-PHP_CodeSniffer下载包解压,复制src目录到php->pear->PHP->CodeSniffer->Standards目录下,并且改名为CodeIgniter



上图为解压后图



上图为放到php代码规范下后的图。
 

PHPSTORM配置PHP_CodeSniffer检测环境

 打开phpstorm的配置框,找到Languages & Frameworks -> php-> Code Sniffer,不同版本的phpstorm可能会有出入,直接搜索Code Sniffer也可以。



点击如下进行编辑:



设置PHP Code Sniffer path为phpcs.bat的路径。



 点击Validate,出现如下图表示设置成功:



打开配置搜索Inspections, 展开PHP,勾选PHP Code Sniffer validation, 选择Coding standard为CodeIgniter, 点击OK确定。



这一步右侧选择Coding standard 的时候 可以先更新一下,点一下右侧的刷新小圆圈,如果你按上面的步骤下载了codelgniter标准,你可以选择它,没下载的话,选择PSR2规范即可,推荐PSR2。

接下来,在编码PHP的时候就会出现规范提示
 


如上图,鼠标移动到有波浪提示的地方,就会出现phpcs的规范提示了。
配置到此结束,希望可以帮到需要的程序猿!
 
最规范的代码就是不出现任何的波浪提示。
以上原文链接:https://www.cnblogs.com/huangbx/p/php_codesniffer.html 

我在原文的基础上删除了一些内容,补充了一些说明。

phpstorm汉化(附带汉化包):
关闭phpstorm

点击下载汉化包(2积分):http://download.csdn.net/download/benpaodelulu_guajian/10139885
下载完成后解压,里面有个压缩包:resources_cn.jar 复制它,将它放到 你的phpstorm安装目录下的lib文件夹里
并且,将自带的resources_en.jar改成别的名字即可然后打开软件就可正常使用了。
以我的为例子:



然后打开软件,就可以看到常用功能都被汉化了。
开始愉快的修改不规范的地方吧~~我一打开全都是波浪线......

有帮助的话,请点个赞,谢谢
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息