编码规范

命名规范

1. 变量命名

变量命名分为普通变量、静态变量、局部变量、全局变量、Session变量等方面的命名规则。

1.1 普通变量

普通变量命名遵循以下规则：

a． 所有字母都使用小写；

b． 对于一个变量使用多个单词的，使用’_’作为每个词的间隔。

例如：$base_dir、$red_rose_price等

1.2 静态变量

普通变量命名遵循以下规则：

a． 所有字母都使用小写；

b． 对于一个变量使用多个单词的，使用’_’作为每个词的间隔。

例如：$base_dir、$red_rose_price等

1.3 局部变量

局部变量命名遵循以下规则：

a． 所有字母使用小写；

b． 变量使用’_’开头；

c． 多个单词组成的局部变量名使用’_’作为每个词间的间隔。

例子：$basedir、$redrose_price等。

1.4 全局变量

全局变量应该带前缀’g’,知道一个变量的作用域是非常重要的。

例如

global $gLOG_LEVEL;

global $gLOG_PATH;

1.5 全局常量

全局变量命名遵循以下规则：

a． 所有字母使用大写

b． 全局变量多个单词间使用’_’作为间隔。

例子：$BASE_DIR、$RED_ROSE_PRICE等。

1.6 session变量

session变量命名遵循以下规则：

a． 所有字母使用大写

b． session变量名使用’S_’开头；

c． 多个单词间使用’_’间隔。

例子：$S_BASE_DIR、$S_RED_ROSE_PRICE等。

2. 类

php中类命名遵循以下规则：

a． 以大写字母开头；

b． 多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。

例子：class MyClass 或class DbOracle等。

3. 方法或函数

方法或函数命名遵循以下规则：

a． 首字母小写；

b． 多个单词间不使用间隔，除第一个单词外，其他单词首字母大写。

例子：function myFunction ()或function myDbOracle ()等。

4. 缩写词

当变量名或者其他命名中遇到缩写词时，参照具体的命名规则，而不采用缩写词原来的全部大写的方式。

例子：function myPear（不是myPEAR） functio getHtmlSource（不是getHTMLSource）。

数据库表名

数据库表名命名遵循以下规范：

a． 表名均使用小写字母；

b． 对于普通数据表，使用_t结尾；

c． 对于视图，使用_v结尾；

d． 对于多个单词组成的表名，使用_间隔；

例子：user_info_t和book_store_v等

书写规则

书写规则是指在编写php程序时，代码书写的规则，包括缩进、结构控制等方面规范：

程序注释

1. 代码缩进

在书写代码的时候，必须注意代码的缩进规则，我们规定代码缩进规则如下：

a． 使用4个空格作为缩进，而不使用tab缩进（对于ultraedit，可以进行预先设置）

例子：

for ( $i=0;$i<$count;$i++ )
{
    echo “test”;
}

2. 大括号{ }书写规则

在程序中进行结构控制代码编写，如if、for、while、switch等结构，大括号传统的有两种书写习惯，分别如下：

a．{直接跟在控制语句之后，不换行，如

for ($i=0;$i<$count;$i++) {
    echo “test”;
}

b．{在控制语句下一行，如

for($i=0;$i<$count;$i++)
{
    echo “test”;
}

其中，a是PEAR建议的方式，但是从实际书写中来讲，这并不影响程序的规范和影响用phpdoc实现文档，所以可以根据个人习惯来采用上面的两种方式，但是要求在同一个程序中，只使用其中一种，以免造成阅读的不方便。

3. 小括号( )和函数、关键词等

小括号、关键词和函数遵循以下规则：

a． 不要把小括号和关键词紧贴在一起，要用一个空格间隔；如if ( $a<$b )；

b． 小括号和函数名间没有空格；如$test = date(“ymdhis”)；

c． 除非必要，不要在Return返回语句中使用小括号。 如Return $a；

4. ＝符号书写

在程序中=符号的书写遵循以下规则：

a． 在=符号的两侧，均需留出一个空格；如$a = $b 、if ($a = = $b)等；

b． 在一个申明块，或者实现同样功能的一个块中，要求=号尽量上下对其，左边可以为了保持对齐使用多个空格，而右边要求空一个空格；如下例：

$testa = $aaa;
$testaa = $bbb;
$testaaa = $ccc;

5. if else swith for while等书写

对于控制结构的书写遵循以下规则：

a． 在if条件判断中，如果用到常量判断条件，将常量放在等号或不等号的左边，例如：

if ( 6 == $errorNum )，因为如果你在等式中漏了一个等号，语法检查器会为你报错，可以很快找到错误位置，这样的写法要多注意；

b． switch结构中必须要有default块；

c． 在for和wiile的循环使用中，要警惕continue、break的使用，避免产生类似goto的问题；

6. 类的构造函数

如果要在类里面编写构造函数，必须遵循以下规则：

a． 不能在构造函数中有太多实际操作，顶多用来初始化一些值和变量；

b． 不能在构造函数中因为使用操作而返回false或者错误，因为在声明和实例化一个对象的时候，是不能返回错误的；

7. 语句断行, 每行控制在80个字符以内

在代码书写中，遵循以下原则：

a． 尽量保证程序语句一行就是一句，而不要让一行语句太长产生折行；

b． 尽量不要使一行的代码太长，一般控制在80个字符以内；

c． 如果一行代码太长，请使用类似 .= 的方式断行书写；

d． 对于执行数据库的sql语句操作，尽量不要在函数内写sql语句，而先用变量定义sql语句，然后在执行操作的函数中调用定义的变量；

例子：

$sql = “SELECT username,password,address,age,postcode FROM test_t “;
$sql .= ” WHERE username=’aaa'”;
$res = mysql_query($sql);

8. 不要不可思议的数字

一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如：

if(22 == $foo) {
    start_thermo_nuclear_war();
} else if(19 == $foo) {
    refund_lotso_money();
} else {
    cry_cause_im_lost();
}

你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如：

define(“PRESIDENT_WENT_CRAZY”, “22”);
define(“WE_GOOFED”, “19”);
define(“THEY_DIDNT_PAY”, “16”);

if(PRESIDENT_WENT_CRAZY == $foo) {
    start_thermo_nuclear_war();
} else if(WE_GOOFED == $foo) {
    refund_lotso_money();
} else if(THEY_DIDNT_PAY == $foo) {
    infinite_loop();
} else {
    happy_days_i_know_why_im_here();
}

9. true/false和0/1判断

遵循以下规则：

a． 不能使用0/1代替true/false，在PHP中，这是不相等的；

b． 不要使用非零的表达式、变量或者方法直接进行true/false判断，而必须使用严格的完整true/false判断；

如：不使用if ($a) 或者if (checka()) 而使用if (FALSE != $a)或者 if (FALSE != check())

10. 避免嵌入式赋值

在程序中避免下面例子中的嵌入式赋值：

不使用这样的方式：

while ($a != ($c = getchar()))
{
    process the character
}

11. 错误返回检测规则

检查所有的系统调用的错误信息，除非你要忽略错误。

为每条系统错误消息定义好系统错误文本，并记录错误LOG。

程序注释

每个程序均必须提供必要的注释，书写注释要求规范，参照PEAR提供的注释要求，为今后利用phpdoc生成php文档做准备。程序注释的原则如下：

a． 注释中除了文件头的注释块外，其他地方都不使用//注释，而使用/* */的注释；

b． 注释内容必须写在被注释对象的前面，不写在一行或者后面；

1. 程序头注释块

每个程序头部必须有统一的注释块，规则如下：

a． 必须包含本程序的描述；

b． 必须包含作者；

c． 必须包含书写日期；

d． 必须包含版本信息；

e． 必须包含项目名称；

f． 必须包含文件的名称；

g． 重要的使用说明，如类的调用方法、注意事项等；

2. 类的注释

类的注释采用里面的参考例子方式：

/**
* @ Purpose: 访问数据库的类，以ODBC作为通用访问接口
* @Package Name: Database
* @Author:
* @Modifications: No20020523-100:
* odbc_fetch_into()参数位置第二和第三个位置调换
* @See: (参照)
*/
class Database
{
    ……
}

3. 函数和方法的注释

函数和方法的注释写在函数和方法的前面，采用类似下面例子的规则：

/**
* @Purpose:
* 执行一次查询
* @Method Name: Query()
* @Param: string $queryStr SQL查询字符串
* @Param: string $username 用户名
* @Author: Michael Lee
* @Return: mixed 查询返回值（结果集对象）
*/
function（$queryStr,$username）
{……}

4. 变量或者语句注释

程序中变量或者语句的注释遵循以下原则：

a． 写在变量或者语句的前面一行，而不写在同行或者后面；

b． 注释采用/* */的方式；

c． 每个函数前面要包含一个注释块。内容包括函数功能简述，输入/输出参数，预期的返回值，出错代码定义。

d． 注释完整规范。

e． 把已经注释掉的代码删除，或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。

f．例子：

/**
* @Purpose:
* 数据库连接用户名
* @Attribute/Variable Name: db_user_name
* @Type: string
*/
var db_user_name;

其他规范（建议）

1. php代码标记

所有的php程序代码块标记均使用

2. 程序文件名、目录名

程序文件名和目录名命名均采用有意义的英文方式命名，不使用拼音或无意义的字母，同时均必须使用小写字母，多个词间使用_间隔。

3. PHP项目通常的文件目录结构

建议在开发规范的独立的PHP项目时，使用规范的文件目录结构，这有助于提高项目的逻辑结构合理性，对应扩展和合作，以及团队开发均有好处。

一个完整独立的PHP项目通常的文件和目录结构如下：

/ 项目根目录

/manage 后台管理文件存放目录

/css css文件存放目录

/doc 存放项目文档

/images 所有图片文件存放路径（在里面根据目录结构设立子目录）

/scripts 客户端js脚本存放目录

/tpl 网站所有html的模版文件存放目录

/error.php 错误处理文件（可以定义到apache的错误处理中）

以上目录结构是通常的目录结构，根据具体应用的具体情况，可以考虑不用完全遵循，但是尽量做到规范化。

4. PHP和HTML代码的分离问题

对性能要求不是很高的项目和应用，我们建议不采用PHP和HTML代码直接混排的方式书写代码，而采用PHP和HTML代码分离的方式，即采用模版的方式处理，这样一方面对程序逻辑结构更加清晰有利，也有助于开发过程中人员的分工安排，同时还对日后项目的页面升级该版提供更多便利。

对于一些特殊情况，比如对性能要求很高的应用，可以不采用模版方式。

5. PHP项目开发中的程序逻辑结构

对于PHP项目开发，尽量采用OOP的思想开发，尤其在PHP5以后，对于面向对象的开发功能大大提高。

在PHP项目中，我们建议将独立的功能模块尽量写成函数调用，对应一整块业务逻辑，我们建议封装成类，既可以提高代码可读性，也可以提高代码重用性。比如，我们通常将对数据库的接口封装成数据库类，有利于平台的移植。

重复的代码要做成公共的库。（除了我们在plug-in产品上遇到的情况，该产品系列有多个相类似的产品，为了尽可能地减少安装包尺寸，不适合将这些产品共用的所有函数做成公共的库）