PHP代码风格指南

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

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

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

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

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

你也能够手动运行 phpcs 命令:框架

phpcs -sw --standard=PSR2 file.php

它会显示出相应的错误以及如何修正的方法。一样地,这条命令也能够用在 git hook 中,若是你的分支代码不符合选择的代码标准则没法提交。编辑器

全部的变量名称以及代码结构建议用英文编写。注释可使用任何语言,只要让如今以及将来的小伙伴可以容易阅读理解便可。ide

相关文章
相关标签/搜索