文档介绍:PHP代码和数据库开发规范(讨论稿)
适用对象:
PHP程序员
发布日期:
待定
制定人:
技术部简张桂
制定日期:
2012年7月3日星期二
适用场景:
开源产品代码除外,自主开发或者二次开发的代码;
_、代码命PHP代码和数据库开发规范(讨论稿)
适用对象:
PHP程序员
发布日期:
待定
制定人:
技术部简张桂
制定日期:
2012年7月3日星期二
适用场景:
开源产品代码除外,自主开发或者二次开发的代码;
_、代码命名规范
(-)命名原则:
统一使用英文单词,不用拼音?
既使用英文单词,又使用拼音?
只使用拼音?
(二)命名规则说明
标准名称
标准说明
示例
Pascal
帕斯卡命名法:单词组合,每个单词首字母大写
ProductType
camel
驼峰命名法:单词组合,第一个单词全小写,后面单词首
字母大写
productType
类匈牙利法
单词组合,单词之间用下划线分割,是PHP内置函数习
惯使用的命名方法,例如mysql_connect0
product_type
(三)PHP代码命名规则
代码对象
使用标准
示例
命名空间
;使用
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
*修改内容:简单说明修改的位置、功能。
*/
(四)