良好的代码规范可以提高代码可读性,团队沟通维护成本。最推荐大家遵守的是 php-fig(PHP Framework Interop Group) 组织定义的 PSR-1 、 PSR-2 两个。不了解的同学可以先通过连接点击过去阅读下。
PHP-CS-Fixer
项目地址: https://github.com/FriendsOfPHP/PHP-CS-Fixer
用来自动格式化你的代码。
通过安装 Composer 安装
composer.phar global require fabpot/php-cs-fixer
请确保~/.composer/vendor/bin
目录在你的系统PATH中。
export PATH="$PATH:$HOME/.composer/vendor/bin"
更多请查看installation
使用fix命令
使用 fix
指令修复文件夹或文件的代码风格
php php-cs-fixer.phar fix /path/to/dir
php php-cs-fixer.phar fix /path/to/file
使用 --level
选项设置修复至的「规范」。
php php-cs-fixer.phar fix /path/to/project --level=psr0
php php-cs-fixer.phar fix /path/to/project --level=psr1
php php-cs-fixer.phar fix /path/to/project --level=psr2
php php-cs-fixer.phar fix /path/to/project --level=symfony
更多使用方式参见 Usage
同类型的还有phpmd
PHPCS
项目地址: https://github.com/squizlabs/PHP_CodeSniffer/
用来检测你的代码规范。
通过安装 Composer 安装
composer global require "squizlabs/php_codesniffer=*"
还可以使用PEAR
pear install PHP_CodeSniffer
下载phar(PHP-CS-Fixer也可以使用此方法)
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar -h
curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
php phpcbf.phar -h
然后移动到命令目录,并添加执行权限:
// 也许需要 sudo
mv phpcs.phar /usr/bin/phpcs
mv phpcbf.phar /usr/bin/phpcbf
chmod +x /usr/bin/phpcs
chmod +x /usr/bin/phpcbf
更多细节请参考:https://github.com/squizlabs/PHP_CodeSniffer/#installation
StyleCI
github上的一款检测代码规范的工具
StyleCI
是一个 Laravel5
项目,功能实现也是由 PHP-CS-Fixer
驱动。
它可以自己分析你项目的 pull request
,并且在你 merge
前显示出分析的结果。
项目地址:https://github.com/StyleCI/StyleCI
官方网站:https://styleci.io/
相关链接
http://blog.csdn.net/cyaspnet/article/details/51773331 https://laravel-china.org/topics/547
来源:oschina
链接:https://my.oschina.net/u/819136/blog/792497