3. 代码风格指南

未匹配的标注

PHP 社区是庞大而多样的,由无数的库、框架和组件组成。PHP 开发人员通常会选择其中的几个并将它们组合到一个项目中。PHP 代码遵循(尽可能接近)通用的代码样式很重要,这样开发人员就可以轻松地为他们的项目混合和匹配各种库。

PHP-FIG 已经提出并批准了一系列风格建议。并不是所有的都与代码风格有关,但是确实与代码风格有关的是  PSR-1PSR-12 and PSR-4。这些建议仅仅是 Drupal、 Zend、 Symfony、 Laravel、 CakePHP、 phpBB、 AWS SDK、 FuelPHP、 Lithium 等许多项目正在采用的一系列规则。你可以在你自己的项目中使用它们,或者继续使用你自己的个人风格。

理想情况下,您应该编写遵循已知标准的 PHP 代码。这可能是 PSRs 的任何组合,或者是 PEAR 或 Zend 制定的编码标准之一。这意味着其他开发人员可以轻松地阅读和使用您的代码,而实现组件的应用程序甚至可以在使用大量第三方代码时保持一致性。

你可以使用PHP_CodeSniffer 根据这些建议中的任何一个检查代码,并为诸如 Sublime Text 之类的文本编辑器提供实时反馈插件。

你可以使用以下工具之一自动修复代码布局:

你可以在 shell 中手动运行 phpcs:

phpcs -sw --standard=PSR1 file.php

它将显示错误并描述如何修复它们。在 git hook 中包含这个命令也很有帮助。这样,包含违反所选标准的分支就不能进入存储库,直到这些违反被修复。

如果你有 PHP_CodeSniffer, 那么你可以通过 PHP Code Beautifier 和 Fixer 自动修复它报告的代码布局问题。

phpcbf -w --standard=PSR1 file.php

Another option is to use the  It will show which kind of errors the code structure had before it fixed them.
另一个选择是使用 PHP Coding Standards Fixer。它将显示代码结构在修复之前出现了哪些错误。

php-cs-fixer fix -v --rules=@PSR1 file.php

所有符号名称和代码基础结构都首选英语。注释可以用任何语言编写,所有当前和未来可能正在编写代码库的各方都可以轻松阅读。

最后,编写干净的 PHP 代码的一个很好的补充资源是 Clean Code PHP.

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/php-the-right-w...

译文地址:https://learnku.com/docs/php-the-right-w...

上一篇 下一篇
贡献者:2
讨论数量: 0
发起讨论 只看当前版本


暂无话题~