PHP专用-干净的代码、命名约定和文档

对于PHP的干净代码、命名约定和文档，有哪些最佳实践

我看到用户/人们说这是一种不好的做法，例如：

// Create an array to hold x values
$arr_x = array();

这是一个不必要的注释，因为语法本身就解释了功能。这应该更多地是描述脚本/函数功能的标题注释，而不是程序的变量/流程。范例

/**
 * Create an array
 */
function create_array() {
   return array();
}

$arr_x = create_array();

// This is just to show the comments and the code is not tested or used except for this example

这让我找到了正确的语法、编码和文档（标题命名的原因）

变量、函数和脚本命名约定可以接受什么，或者这是个人偏好

$varX
function varX()
varX.php

或

---

我在努力寻找是否有一个我应该遵守的标准。感谢Zend Framework提供了一个PHP编码标准文档，其中应该包括如何命名变量和函数等内容

---

评论的时间和方式与平台无关。我认为一个好的一般规则是评论为什么做某事，而不是如何做。代码应该写得足够清楚，以使其更加明显。（当然也有例外，例如使用特别复杂的算法，可能需要解释。）

Zend Framework有一个PHP编码标准文档，应该包括如何命名变量和函数等内容

---

评论的时间和方式与平台无关。我认为一个好的一般规则是评论为什么做某事，而不是如何做。代码应该写得足够清楚，以使其更加明显。（当然也有例外，比如使用特别复杂的算法，可能需要解释。）

这我称之为反模式。当数据类型发生变化时，您会怎么做？您是否会更改整个项目，或者更改许多使用您的代码的其他项目

我宁愿使用简单的：

$x
function x()
x.php

---

这就是我所说的反模式。当数据类型发生变化时，您会怎么做？您是否会更改整个项目，或者更改许多使用您的代码的其他项目

我宁愿使用简单的：

$x
function x()
x.php

---

没有标准，只有开发者的意见

我更喜欢用下划线分隔变量：

$my_var

但对于函数，我更喜欢驼峰式：

function myFunction() {}

至于注释，是的，有时根本不需要像

//create array

这样的注释，但是不要使用一行程序来拖延，它们不会在脚本执行时减慢脚本的速度。我喜欢用一行字来简洁地描述复杂脚本的每个步骤

---

只要您的代码对您和其他开发人员（项目中的其他人、第三方公司等）是可读的，那么您就可以了。

没有标准，只有开发人员的意见

我更喜欢用下划线分隔变量：

$my_var

但对于函数，我更喜欢驼峰式：

function myFunction() {}

至于注释，是的，有时根本不需要像

//create array

这样的注释，但是不要使用一行程序来拖延，它们不会在脚本执行时减慢脚本的速度。我喜欢用一行字来简洁地描述复杂脚本的每个步骤

---

只要您的代码对您和您的开发伙伴（项目中的其他人、第三方公司等）是可读的，那么您就不会有问题。

最重要的是保持一致性。除了基本的描述变量、函数和方法名之外，真正重要的是一致性

---

如果您不想想想太多，可以随意使用流行的编码风格指南，如PEAR项目中的指南，或JacobM刚刚发布的Zend框架标准。

最重要的是保持一致性。除了基本的描述变量、函数和方法名之外，真正重要的是一致性

---

如果你不想想想得太多，可以随意使用一个流行的编码风格指南，比如PEAR项目中的指南，或者JacobM刚刚发布的Zend框架标准。

我使用codeigniter，这是他们的风格指南

---

我使用codeigniter，这是他们的风格指南

---

雅各布刚刚发布了一个很好的PHP标准文档。但是，如果我正在编辑或添加现有代码，我会尝试遵循前一位作者所阐述的风格。

JacobM刚刚发布了一个很好的PHP标准文档。但是，如果我正在编辑或添加现有代码，我会尝试遵循前一位作者所设计的样式。

找到一个您喜欢的标准，或与现有代码库最匹配的标准，这得到了该工具的支持，并安装了该工具，至少您可以使用该工具检查代码是否存在差异。

找到您喜欢的标准，或与现有代码库最匹配的标准，这得到了该工具的支持——并安装了该工具——至少您可以使用该工具检查代码是否存在差异。

一个重要的事情是一致性。无论您为您的开发团队选择什么标准（上述任何标准），都要确保您的开发组织中的每个人都遵守这些标准。否则，代码将很难阅读，代码审查也很困难

一件重要的事情是一致性。无论您为您的开发团队选择什么标准（上述任何标准），都要确保您的开发组织中的每个人都遵守这些标准。否则，代码将很难阅读，代码审查也很困难

Drupal是用PHP编写的最大的开源代码库之一

他们必须有一些好的代码约定

---

Drupal是用PHP编写的最大的开源代码库之一

他们必须有一些好的代码约定

---

php中的编码标准一直在变化。如果你看看旧的框架，它们都使用驼峰案例，在我看来，这可能会导致代码中的错误。对于java这样的语言来说，这是有意义的，但对于php则没有意义

最近的codi