PHP代码和数据库开发规范讨论稿2012-7-13.doc

PHP代码和数据库开发规范（讨论稿）

适用对象：
PHP程序员
发布日期：
待定
制定人：
技术部 简张桂
制定日期：
2012年7月3日 星期二
适用场景：
开源产品代码除外，自主开发或者二次开发的代码；

一、 代码命名规范

（一） 命名原则：
统一使用英文单词，不用拼音？
既使用英文单词，又使用拼音？
只使用拼音？

（二） 命名规则说明
标准名称
标准说明
示例
Pascal
帕斯卡命名法：单词组合，每个单词首字母大写
ProductType
camel
驼峰命名法：单词组合，第一个单词全小写，后面单词首字母大写
productType
类匈牙利法
单词组合，单词之间用下划线分割，是PHP内置函数习惯使用的命名方法，例如mysql_connect。
product_type

（三） PHP代码命名规则
代码对象
使用标准
示例
命名空间
PHP在5.3.0版本之后开始支持命名空间；使用Pascal标准，以 Jk39\作为前缀，例如：
Jk39\Db\Connect
Jk39\Db\Connect
类
使用Pascal标准，不能多个类放一个php文件，一类一文件；
Products
DbHelper
类私有字段
使用camel标准，并加下划线“_”作为前缀
$_productName
类公共属性
使用camel标准
$productName
公共(私有)方法
使用camel标准
getProducts( )
方法参数
使用camel标准
$productName
变量
使用camel标准
$productName
常量
全大写，每个单词之间用下划线隔开
CONST_DATA

二、 代码格式规范

（一） 代码缩进：
使用开发工具默认的缩进策略，每对花括号里的语句块相对上一层代码缩进一个Tab位置（四个半角字符），并且每个右花括号独立一行，左花括号放到语句末尾。例：
class name {

function name() {

}
}

（二） 空格应用：
应用场景
示例
所有二元、三元运算符和等号两边各加一空格
$primaryKey = value;
同一行中间出现逗号(“,”)，逗号后加一空格,括号两边方空格
ClassMethod( $parName, $parAge )
同一行中间出现分号（“;”），后加一空格
for ( int $iKey = 0; $iKey < 10; $iKey++ )

（三） 代码文件头部说明：
头部说明主要是为了写明该代码文件的作用、作者、创建时间，有助于代码维护。
格式如下：
/*-----------------------------------------------------------------------------------
* 作用：
* 作者：黄润成 创建时间： 2011-3-10
* 修改人1：黄润成 修改时间： 2012-5-25
* 修改内容： 简单说明修改的位置、功能。
* 修改人2：黄润成 修改时间： 2012-5-25
* 修改内容： 简单说明修改的位置、功能。
-----------------------------------------------------------------------------------*/

（四） 代码分块：
同一代码文件中若干个功能相关的方法，或同一功能块的代码，如果代码较长和较复杂，应新建函数或者方法进行剥离：

（五） 类方法、属性注释（说明功能）：
对所有的属性和方法，必须注释说明方法、每个方法参数、属性的作用，并统一使用以下格式（开发工具中，在属性或方法名称上一行首输入三个右斜杠“/**”并回车后会自动完成注释的格式，只需填充注释内容即可）：
class ttt {

/**
* Enter description here...
*
* @param int $pid
* @return ttt
*/
function ttt( int $pid = 0 ) {
return $pid;
}
}

（六） 代码行注释（说明逻辑）：
对逻辑比较复杂的代码，必须在行间注释，统一使用“//”注释符号插入注释。注释内容应简洁明了，用两三句话来概括几行代码的逻辑。

代码行格式：
1、 每行代码或注释长度不超过100个字符，超过就换行，防止横向翻屏。
2、 接口/类的定义之间、方法与方法之间、变量声明与代码之间、代码中不同逻辑块之间，要使用空行分隔，让代码更加清晰，方便阅读。
private function isMobile() {
if (isset($this->session->data['ismobile']))
return $this->session->data['ismobile'];

$is_mobile = 0;

if (isset($_SERVER['HTTP_USER_AGENT'])) {
……

三、 数据库规范
（一） 表的主要字段约定(如果需要字段，则以下面格式为准)
字段说明
字段名称
字段类型
主键
*_id
INT(*) PRIMARY KEY
录入日期
create_on
INT(10)
录入人
create_user
Varchar(50)
修改日期
modified_on
INT(10)
修改人
modified_user
Varchar(50)

【文档结束】
第 6 页 / 共 6 页