【PHP】代码风格指南

PHP 社区百花齐放,拥有大量的函数库、框架和组件。PHP 开发者通常会在自己的项目中使用若干个外部库,因此 PHP 代码遵循(尽可能接近)同一个代码风格就非常重要,这让开发者可以轻松地将多个代码库整合到自己的项目中。

框架互操作标准组 提出并通过了一系列的编码风格建议。其中有部分是关于代码风格的,即 PSR-0PSR-1PSR-2 和 PSR-4。这些建议只是一些正在被开源项目所遵循的规则,如 Drupal、Zend、Symfony、Laravel、CakePHP、phpBB、AWS SDK、FuelPHP、Lithium 等。你可以把这些规则用在自己的项目中,或者继续使用自己的风格。

理想情况下,你应该遵循一个已知的标准来编写 PHP 代码。可能是 PSR、PEAR 或 Zend 编码准则中的一个。这样做的好处是其他开发者能够方便的阅读和使用你的代码,并且使用这些组件的应用程序可以和其他第三方的组件保持一致。

你可以使用 PHP_CodeSniffer 来检查代码是否符合这些准则,文本编辑器 Sublime Text 的插件也可以提供实时检查。

你可以通过以下两个工具来自动修复代码布局:

你可以在命令行中手动运行 phpcs :

phpcs -sw --standard=PSR2 file.php

它可以把出错的地方列出来并且指示如何修改。 它还可以用在 git hook 中。 在这种使用方式下,如果你的分支代码不符合选择的代码标准则无法提交,直到修改之后才能提交。

If you have PHP_CodeSniffer, then you can fix the code layout problems reported by it, automatically, with the PHP Code Beautifier and Fixer.

phpcbf -w --standard=PSR2 file.php

另一种选择是使用 PHP Coding Standards Fixer。 他可以在修正错误之前列出代码结构中的错误和错误类型。

php-cs-fixer fix -v --level=psr2 file.php

所有的变量名称以及代码结构建议用英文编写。注释可以使用任何语言,只要让现在以及未来的小伙伴能够容易阅读理解即可。

点赞

发表评论

电子邮件地址不会被公开。必填项已用 * 标注