PHP编码规范



每个公司都根据其最佳实践遵循其自身的编码规范。需要编码规范是因为可能有许多开发人员在不同的模块上工作,如果他们开始制定自己的规范,那么源代码将变得非常难以管理,并且将来难以维护该源代码。

以下是一些应该使用编码规范的原因:

  • 您的同行程序员必须理解您编写的代码。编码规范充当所有团队破译代码的蓝图。

  • 一致的编码实现的简洁性和清晰性可以避免常见的错误。

  • 如果您过段时间修改代码,那么理解该代码就很容易了。

  • 遵循统一的编码规范可以提高软件质量。

在PHP中编码时,可以遵循一些指导原则。

缩进和行长

使用4个空格缩进,不要使用制表符,因为不同的计算机使用不同的制表符设置。建议将行长保持在约75-85个字符,以提高代码的可读性。

控制结构

这些包括if、for、while、switch等。控制语句在控制关键字和左括号之间应留一个空格,以将其与函数调用区分开来。强烈建议始终使用花括号,即使在技术上可选的情况下也是如此。

示例

if ((condition1) || (condition2)) {
   action1;
} elseif ((condition3) && (condition4)) {
   action2;
} else {
   default action;
}

您可以按如下方式编写switch语句

switch (condition) {
   case 1:
      action1;
      break;

   case 2:
      action2;
      break;

   default:
      defaultaction;
      break;
}

函数调用

函数调用时,函数名、左括号和第一个参数之间不应有空格;逗号和每个参数之间应有空格;最后一个参数、右括号和分号之间不应有空格。示例如下:

$var = foo($bar, $baz, $quux);

函数定义

函数声明遵循“BSD/Allman风格”:

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

注释

C风格注释(/* */)和标准C++注释(//)都可以。允许使用Perl/shell风格注释(#),但不鼓励使用。

PHP代码标签

始终使用<?php ?>来分隔PHP代码,而不是<? ?>简写。这是PHP兼容性所必需的,也是在不同操作系统和设置上包含PHP代码最可移植的方式。

变量名

  • 使用全部小写字母

  • 使用'_'作为单词分隔符。

  • 全局变量应以'g'开头。

  • 全局常量应全部大写,并用'_'分隔。

  • 静态变量可以以's'开头。

使函数可重入

函数不应保留阻止函数可重入的静态变量。

声明块的对齐

声明块应对齐。

每行一个语句

除非语句非常密切相关,否则每行应只有一个语句。

短方法或函数

方法应限制在一页代码内。

编写PHP程序时,可能还需要考虑许多其他方面。总的意图应该是在整个代码编程过程中保持一致,只有遵循任何编码规范才有可能。如果您喜欢不同的东西,您可以设计您自己的规范。

广告