PHP程序编码规范

声明：这是从别人的资料总结整理出的规范笔记

一、排版规则

1.1缩进

对齐只使用空格键，不使用TAB键。缩进的单位为4个空格。

1.2空格规则

空格应在以下情况时使用：

*跟在（）的关键字应用一个空格隔开。

*函数名与左括号之间不应该有空格。

*所有的二元操作符，除了左括号和左方括号应用各个将其与操作数隔开。

*一元操作符与其操作数之间不应有空格。

*每个在控制部分，比如for语句中的；后须跟一个空格。

*每个，后应跟一个空格。

1.2.1 逻辑运算符前后必须加空格

1.2.2 多个参数分隔时必须加空格

1.2.3 语法关键字后必须加空格

1.2.4 字符串和变量连接规则

字符串与变量连接使用‘ . '号时，必须在’ . ‘前后加空格，使用”号自动转义变量时必须在变量前后加“ {} ”

1.3 换行

每行一个语句，除非这些语句有很密切的联系，否则每行只写一个语句。相对独立的程序块之间、变量说明之后必须加空行。

1.3.1 较长的语句（>80字符）

要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分的新行要适当的缩进，使排版整齐，语句可读。

二、命名规范

2.1变量命名

2.1.1局部变量

所有变量都要预先声明，并注明其意义，在函数的首部定义所有的变量。不要使用一个声明一个；最好把每个变量的声明语句单独放到一行，并加上注释说明。所有变量按照字母排序。

2.1.2全局变量命名

全局变量使用g前缀。如： global $gLog;

2.1.3静态变量命名

静态变量使用s前缀，如：￥s_value。

2.1.4引用变量和函数返回引用

引用必须带‘ r ’前缀

2.1.5临时变量命名

不用将在循环中频繁使用的临时变量如$i,$j等用于其他用途。

2.1.6方法中参数命名

参数的名字使用Camel命名方法（首字母小写），在首字符后的所有字都按照类命名规范首字符大写。

2.2命名定义/全局常量

全局常量用‘ — ’分隔每个单词。

2.3类命名

用Pascal命名规则，尽量谨慎的使用缩写，不要用下划线作类名单词连接符。

2.3.1接口命名原则

接口名字在类的原则上加前缀I。

2.3.2 Exception命名原则

异常的命名以“Exception "为后缀。

2.3.3 类库命名

为了避免类名冲突，一般的做法是在类名前加上独特的前。

2.3.4 方法命名

采用与类命名一致的规则

2.3.5 方法/函数命名修饰

它们的命名应该清楚的说明它们是做什么的。

2.3.6 类属性命名

使用英文名词、动词，以大写字母作为词的分隔。

2.3.7 私有属性与私有方法命名

以 _ 开头。

2.3.8 对象命名

使用类名称为变量前缀，所有字母都使用大写，以字符串_obj为后缀。

2.4 缩写词不要全部使用大写字母

2.5 函数命名

函数名采用C GNU的惯例，所有的字母使用小写字母，使用‘ _ ’分割单词。

三、板式规则

3.1 语义分隔

各个函数、方法之间应该采用空行间隔。

3.2 圆括号规则

函数名与括号直接不需要加空格、语法关键字后的括号必须加空格。

3.3 方法/函数

函数名与（之间不应该有空格。）与开始程序体的{ 之间应该插入一个空格。函数程序体应缩进四个空格。}与声明函数的那一行代码头部对齐。。

3.4 关键字

if 、for 、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

 

四、编程规范

4.1 数组定义规则

数组定义和使用时中key值前后必须加单引号。

4.2 不要采用缺省方法测试非零值

不要采用缺省值测试非零值，也就是使用：

if (FAIL != f())

比下面的方法好：

if (f())

4.3 通常避免嵌入式的赋值

4.4 布尔逻辑类型

大部分函数在FALSE的时候返回0，但是发挥非0值就代表TRUE，因而不要用1（TRUE，YES，诸如此类）等式检测一个布尔值，应该用0（FALSE,NO,诸如此类）的不等式来代替：

4.5 别在对象架构函数中做实际的工作

4.6 switch 格式

当一个case块处理后，直接转到下一个case块处理，在这个case块的最后应该加上注释。

default case总应该存在，它应该不被到达，然而如果到达了就会触发一个错误。

如果你要创立一个变量，那就把所有的代码放在块中。