PHP 编码规范
-
PHP 编码规范
每家公司都根据其最佳实践遵循不同的编码标准。编码标准是必需的,因为可能有许多开发人员在不同的模块上工作,所以如果他们开始发明他们自己的标准,那么源将变得非常难以管理,并且将来很难维护该源代码。以下是使用编码规范的几个原因- 您的同行程序员必须了解您生成的代码。编码标准是所有团队破译代码的蓝图。
- 通过一致的编码实现的简单性和清晰度使您免于常见错误。
- 如果您在一段时间后修改代码,那么很容易理解代码。
- 其行业标准遵循特定标准,以提高软件质量。
在PHP中编码时,可以遵循的指导原则很少。- 缩进和行长度 - 使用4个空格的缩进并且不使用任何tab键,因为不同的计算机对制表符使用不同的设置。建议将行长保持在大约75-85个字符,以提高代码的可读性。
- 控制结构 - 包括if,for,while,switch等。控制语句在关键字和左括号之间应该有一个空格,以区别于函数调用。强烈建议您使用花括号,即使在技术上是可选的(不需要花括号也能正确运行)情况下也是如此。
-
规范例子
if...elseif...else结构您可以按如下方式编写switch语句函数调用 - 调用函数,函数名,左括号和第一个参数之间不能有空格; 逗号和每个参数之间的空格,最后一个参数,右括号和分号之间没有空格。这是一个例子函数定义 - 函数声明遵循“BSD/Allman风格” -- 注释 - C样式注释(/ * * /)和标准C++注释(//)都很好。不鼓励使用Perl/shell样式注释(#)。
- PHP代码标签 - 总是使用<?php?>来分隔PHP代码,而不是<?简写。这是PHP合规性所必需的,也是在不同操作系统和设置中包含PHP代码的最便携方式。
-
变量名称 -
- 使用全部小写字母
- 使用'_'作为单词分隔符。
- 全局变量应该以'g'为前缀。
- 全局常量应该全部带有'_'分隔符。
- 静态变量可以以's'为前缀。
- 使函数可重入 - 函数不应保留阻止函数重入的静态变量。
- 声明块的对齐 - 声明块应该一致。
- 每行一个声明 - 除非声明密切相关,否则每行应该只有一个声明。
- 简短方法或函数 - 方法应将自己限制为单页代码。
在编写PHP程序时,可能还需要考虑更多的要点。在整个代码编程中,所有意图应该是一致的,只有当你遵循任何编码标准时才有可能。如果你喜欢不同的东西,你可以设置自己的标准。建议使用大众都接受的规范,除非您有更好的办法可以让大家接受。