PHP代码编写规范讲解.doc

PHP代码编写规范 一、编辑器设置 （1）使用Tab缩进，不要使用空格 鉴于很多编辑器在保存文件时会自动清除用于缩进的空格，所以我们一律使用Tab键进行缩进。 （2）UNIN文件格式 请将编辑器设置对所有程序使用UNIX格式保存，不要使用Win32或者Mac的格式。例如，EditPlus里面Document-File Format(CR/LF)-Unix 。对于windows格式文件，以Ctrl + M结束（vim下为^M）,需要过滤掉： $text = strtr($text, \x0D, ); 二、命名设置 1、公共库名称空间 TPLIB，Tencent PHP Library 2、变量命名所有字母都使用小写 首字母根据变量值类型指定 整数I浮点数f字符串s布尔值b数组a对象o资源r混合类型m 使用’_’作为每一个词的分界 例如： $i_age_max = 10; $f_price = 22.5; $s_name =‘harry’; $b_flag = true; $a_price = array(); $o_object = new class(); $r_file = fopen(); $m_var = array_combine($a_name, $a_flag);?类命名使用大写字母作为词的分隔，其他的字母均使用小写，即驼峰格式。 名字的首字母使用大写 不要使用下划线(’_) interface接口最好使用大写字母I,并以Interface结尾 例如： class NameOneTwo class Name interface IExampleInterface () 方法命名 使用大写字母作为词的分隔，其他的字母均使用小写 名字的首字母使用大写,声明为 “private” 或 “protected” 的，使用’_’为前缀 不要使用下划线(’_) 与类命名一致的规则 对象的访问器总是以 “get” 或 “set” 为前缀，当使用设计模式如 单态模式（singleton）或工厂模式（factory），方法的名字应当包含模式的名字，这样容易从名字识别设计模式。 例如： class NameOneTwo{ public function DoIt() {}; protect function _HandleError() {}; private function _SayHello() {}; } 类属性命名 属性名前缀应以属性值类型指定（具体参照变量命名规则） 前缀后采用与类命名一致的规则 私有属性采用’_’为前缀 例如： class NameOneTwo { public function VarAbc() {}; public function ErrorNumber() {}; public $iAge; private $_iAge; } 方法中参数命名 参照类属性命名 例如： class NameOneTwo { public function VarAbc($sMsg) {}; } 全局变量 全局变量应该带前缀‘g’ 其余参照变量命名规则 例如： global $gi_Age; global $ga_Price 定义命名/全局常量 全局常量使用’_’分割每个单词 所有字母使用大写 例如： define(‘E_ERROR_MISSING_PARA’, 501); 函数 所有的字母采用小写，使用’_’分割每个单词 例如： function some_bloody_function(){ }大括号{}规则 将大括号放置关键词下方的同列处或同行，推荐放到同行 例如： function some_bloody_function() { } if (true) { // code } 缩进/制表符规则 使用制表符缩进 例如： function some_bloody_function() { if (true) { //code } } 小括号、关键词和函数规则 不要把小括号和关键词紧贴在一起，要用空格隔开它们 小括号和函数名要紧贴在一起 除非必要，不要在Return返回语句中使用小括号 例如： if (condition) { } strcmp($sHello, $sEvening); return 1; If Then Else格式 布局 if (条件1) { //注释 } else if (条件2) { //注释 } else { //注释 } 如果你有用到else if语句的话，通常最好有一个else块以用于处理未处理到的其他情况。可以的话放一个记录信息注释在else处，即使在else没有任何的动作。 条件格式 总是将恒量放在等号/不等号的左边，例如： if ( 6 == $errorNum )