文档介绍：武汉网杰PHP开发规范
统一开发规范
在代码编写过程中,会根据不同人的习惯产生不同的代码风格。这样会降低代码的可读性,而且这样会降低工作效率,所以有必要统一开发规范,下面的规范不一定是完整的“标准”,但基本上参考了PHP编码规范的文档。
采用哪种“标准”并不重要,关键在于公司内部是“标准”的,是“统一”的。
PHP文件格式
对于只包含有PHP代码的文件,结束标志(“?>”)是不允许存在的,PHP自身不需要(“?>”),这样做可以防止它的末尾被意外的注入。
代码缩进由四个空格组成,禁止使用制表符TAB缩进,因为在不同的编辑器当中,制表符的缩进不同。
行结束标志遵循Unix文本文件的约定,行必须以单个换行符(LF)结束。即:\n
PHP编码风格一
空格不能少,运算符之间必须用空格分开, 如:$a + $b 或者$a = ‘show’;
函数或方法的参数之间必须用空格分开, 如:foo ($a, $b);
流程控制中,参数和命令和括号之间必须用空格分开, 如:foreach ($a as $key => $value);
单引号和双引号的区别,单引号中的字符是不会转义的(如:\n),双引号中的字符可以被转义,而且能够识别变量(”$variable”)。所以尽量使用单引号,而不是双引号。
PHP编码风格二
关联数组的定义,采用多行定义。如:$array = array( ‘a’=> $a, ‘b’=> $b );
非关联数组也可以按此规则定义,如果只有几项,可以写在一行,但之间要确保有空格隔开。如:$array = array ($a, $b, $c);
PHP编码风格三
在流程控制语句中,大括号不应另起一行。 如:if($true){ action()…}else{ action()…}
数据库设计及使用一
未经特别说明统一使用MYSQL数据库;
数据库引擎未经特别说明统一使用MyISAM引擎;
未经特别说明统一使用UTF8字符集,使用utf8_general_ci校对字段;
不是通用的字段,如:username, password,一律要加注释说明;
外键一律使用与外键所在表字段名不同名称命名。
数据库设计及使用二
判断是否关系的字段使用tinyint(1)类型;
需要主键子增加的使用auto_increment;
对定长字符串使用CHAR类型;
对于时间类型,需要显示处理时间到秒的使用INT(10),如果只使用日期,比如:20110310,这样的形式使用INT(8)。
类的命名约定
类文件名首字母必须大写,其他任何文件都必须使用小写;
类的名称要求每个单词的首字母要大写;
类的方法使用驼峰式命名规则,即:getLastPage()。第一个单词要小写,后面单词的首字母必须大写;
变量的命名同类方法,生命为“private”或者“portected”的实例变量名必须以一个单个下划线开头;
常量名的所有字母都要大写。
类的编码风格
在类和类的方法还有函数的定义中,大括号必须另起一行。 Class A { public function __consTruct() { action()…} }