PHPCMS开发文档里看到PHP编码规范（2）

4.2.注释

注释是对于那些容易忘记作用的代码添加简短的介绍性内容。请使用 C 样式的注释“/* */”和标准 C++ 注释“//”。

程序开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以免日后遗忘。所有临时性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。例如：

$num = 1;

$flag = TRUE; //debug 这里不能确定是否需要对$flag进行赋值

if(empty($flag)) {

//Statements

}

4.3.书写规则

4.3.1. 缩进

每个缩进的单位约定是一个TAB(8个空白字符宽度)，需每个参与项目的开发人员在编辑器(UltraEdit、EditPlus、Zend Studio等)中进行强制设定，以防在编写代码时遗忘而造成格式上的不规范。

本缩进规范适用于PHP、JavaScript中的函数、类、逻辑结构、循环等。

4.3.2. 大括号{}、if和switch

首括号与关键词同行，尾括号与关键字同列;

if结构中，if和elseif与前后两个圆括号同行，左右各一个空格，所有大括号都单独另起一行。另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰;

switch结构中，通常当一个case块处理后，将跳过之后的case块处理，因此大多数情况下需要添加break。break的位置视程序逻辑，与case同在一行，或新起一行均可，但同一switch体中，break的位置格式应当保持一致。

以下是符合上述规范的例子：

If ($condition)

{

switch ($var)

{

case 1: echo ‘var is 1’; break;

case 2: echo ‘var is 2’; break;

default: echo ‘var is neither 1 or 2’; break;

}

}

else

{

switch ($str)

{

case ‘abc’:

$result = ‘abc’;

break;

default:

$result = ‘unknown’;

break;

}

}

4.3.3. 运算符、小括号、空格、关键词和函数

每个运算符与两边参与运算的值或表达式中间要有一个空格，唯一的特例是字符连接运算符号两边不加空格;

左括号“(” 应和函数关键词紧贴在一起，除此以外应当使用空格将“(”同前面内容分开;

右括号“)”除后面是“)”或者“.”以外，其他一律用空格隔开它们;

除字符串 * 意需要，一般情况下，在程序以及HTML中不出现两个连续的空格;

任何情况下，PHP程序中不能出现空白的带有TAB或空格的行，即：这类空白行应当不包含任何TAB或空格。同时，任何程序行尾也不能出现多余的TAB或空格。多数编辑器具有自动去除行尾空格的功能，如果习惯养成不好，可临时使用它，避免多余空格产生;

每段较大的程序体，上、下应当加入空白行，两个程序块之间只使用1个空行，禁止使用多行。

程序块划分尽量合理，过大或者过小的分割都会影响他人对代码的阅读和理解。一般可以以较大函数定义、逻辑结构、功能结构来进行划分。少于15行的程序块，可不加上下空白行;

说明或显示部分中，内容如含有中文、数字、英文单词混杂，应当在数字或者英文单词的前后加入空格。

根据上述原则，以下举例说明正确的书写格式：

$result = (($a + 1) * 3 / 2 + $num)).’Test’;

$condition ? func1($var) : func2($var);

$condition ? $long_statement

: $another_long_statement;

if ($flag)

{

//Statements

//More than 15 lines

}

Showmessage(‘请使用 restore.php 工具恢复数据。’);

4.3.4. 函数定义

l 参数的名字和变量的命名规范一致;

l 函数定义中的左小括号，与函数名紧挨，中间无需空格;

l 开始的左大括号另起一行;

l 具有默认值的参数应该位于参数列表的后面;

l 函数调用与定义的时候参数与参数之间加入一个空格;

l 必须仔细检查并切实杜绝函数起始缩进位置与结束缩进位置不同的现象。

例如，符合标准的定义：

function authcode($string, $operation, $key = '')

{

if($flag)

{

//Statement

}

//函数体

}

不符合标准的定义：

function authcode($string,$operation,$key = '') {

//函数体

}