代码风格指南

代码风格指南

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

PHP标准组 提出并发布了一系列的风格建议。其中有部分是关于代码风格的，即 PSR-0, PSR-1, PSR-2 和 PSR-4。这些推荐只是一些被其他项目所遵循的规则，如 Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Lithium 等。你可以把这些规则用在自己的项目中，或者继续使用自己的风格。

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

阅读 PSR-0

阅读 PSR-1

阅读 PSR-2

阅读 PSR-4

阅读 PEAR 编码准则

阅读 Symfony 编码准则

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

你可以通过以下两个工具来自动修正你的程序语法，让它符合标准。 一个是 PHP Coding Standards Fixer，它具有良好的测试。 另外一个工具是 php.tools， 它是 sublime text 的一个非常流行的插件sublime-phpfmt，虽然比较新，但是在性能上有了很大的提高，这意味着实时的修复语法会更加的流畅。

你也可以手动运行 phpcs 命令：

    phpcs -sw --standard=PSR2 file.php

它会显示出相应的错误以及如何修正的方法。同样地，这条命令也可以用在 git hook 中，如果你的分支代码不符合选择的代码标准则无法提交。

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