PHP语言中的PSR-2及相关工具

PSR-2 是Coding Style Guide,表示 PHP 代码格式规范,PHP 语言流行的原因之一就是编写代码没有约束,长期以来 PHP 没有格式规范的,虽然以前也有 PEAR 标准的规范,但现在越来越不流行了。这时候 PSR-2 标准出现了,它的出现应该感谢 Packagist(The PHP Package Repositor) 和 命名空间的出现,PSR-2 成为了名义上的官方代码标准。

代码格式规范个人认为解决了两个问题,第一就是代码一致性,避免在写代码的时候为格式问题而费劲心思;第二就是可读性,让你的代码更容易被理解。代码格式规范虽然不是强制的,但却是编码过程中必不可少的一部分,另外代码格式规范和变量、函数、类、文件等命名规范不是一回事。

在代码格式规范中,个人觉得以下几方面比较重要,花括号的匹配形式、换行的处理艺术、 tab 键和空格的使用。

PHP CodeSniffer

PHP CodeSniffer 是 PHP 代码的分析工具,能够以特定的代码格式标准检测代码,建议你安装最新的版本,因为老版本是不支持 PSR-2 标准的。常用的几个命令:

phpcs -h
phpcs -version
phpcs -i #显示所有支持的代码标准
phpcs --extensions=php #仅仅检查 PHP 后缀的文件
phpcs --standard=psr2 file.php 
phpcs --ignore=".gitignore",*/data/* /path/code
phpcs -e  --standard=psr2
phpcs --standard=psr2 --sniffs=Generic.PHP.LowerCaseConstant #only run two sniffs over the code instead of all sniffs
phpcs --standard=psr2 --exclude=Generic.PHP.LowerCaseConstant #run all sniffs except for the two specificed

PHP Coding Standards Fixer

PHP CodeSniffer 只能检测代码出现什么格式问题,但是不能自动修复,而 PHP Coding Standards Fixer 却可以。另外请务必使用最新版本,查看使用方法也尽量在 Github 上看。

使用方法很简单:

php-cs-fixer fix /path/code --rules=@PSR2
php-cs-fixer fix /path/code --rules=@PSR2,strict_comparison

在使用过程中有个问题说明下,类似下面的代码,多余的空格是不能修复的,有谁知道如何处理,还请告之

$x =             10;
if ($x        > 10) { 
    echo         'ok';
}

如何在 Netbeans 上支持 PSR-2 标准

在 Netbeans 是内置了一个 PHP 代码格式标准,假如需要使用 PSR-2 标准,需要安装 Netbeans-psr 插件,安装后可以在 【工具->选项->编辑器->格式设置】中调整具体的语法格式,可以看下面这张图。

![Netbeans 格式设置][netbeans_psr-2_1]
[netbeans_psr-2_1]: http://notes.newyingyong.cn/static/image/2017/netbeans_psr-2_1.png "Netbeans 格式设置"

设置后,可以对代码进行格式化,让代码符合 PSR-2 标准,也可以在 Netbeans 中配置保存代码的时候(CTRL+S)可以自动格式化,目前我使用的就是这种方式,感觉还不错。

在 Netbeans 中使用 php-cs-fixer 软件

可以在 Netbeans 中运行 php-cs-fixer 来格式化代码,首先要安装一个插件,注意不是在【工具->选项->PHP->编码标准修复程序】中进行配置,具体可以查看这个 issues

第二个问题就是在使用这个插件的时候,要注意 Netbeans 版本、php-cs-fixer 版本、插件版本,为这个问题我还提了个 issues

Submine Text 中使用 php-cs-fixer 软件

这个插件是一个综合的插件,安装并配置后,可以很方便的格式化代码。

{
    "php_cs_fixer_on_save": false,
    "php_cs_fixer_show_quick_panel": true,
    "php_cs_fixer_executable_path": "C:\\vendor\\bin\\php-cs-fixer.bat",
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,911评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,014评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 142,129评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,283评论 1 264
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,159评论 4 357
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,161评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,565评论 3 382
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,251评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,531评论 1 292
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,619评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,383评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,255评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,624评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,916评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,199评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,553评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,756评论 2 335

推荐阅读更多精彩内容