PHP编码规范.docx

1、PHP编码规范PHP编码规范（第一版）酷乐网 momo 整理（momo ）1 文件结构|images|include|parameter|config|function|indeximages存放图片文件，include中是系统是要引用的文件，一般在parameter中存放参数文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模块的分类，将各功能的类也放入其中2 文件名文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件)，flash（存放Flas

2、h文件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include文件)，link（存放友情链接）,media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。3 源文件的编码规范3.1 开头注释所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、功能、版本信息、日期、作者和版权声明：/* 类名* 功能* 版本* 日期* 作者* 版权*/如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置/* 修改目的

3、* 修改日期* 修改人* 版本*/修改起始修改结束3.2 引入语句引入语句应该位于文件的头部，并在引入时说明引入文件的作用。例如：/数据库操作类require( “db.php” );3.3 类的声明1 类文档注释(/*/) 该注释中所需包含的信息，参见文档注释2 类的声明3 类实现的注释(/*/)如果有必要的话 该注释应包含任何有关整个类的信息，而这些信息又不适合作为类文档注释。4 类的(静态)变量 首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。5 实例变量 首先是公共级别的，随后是保护级别的，再后是包一级别的(没

4、有访问修饰符)，最后是私有级别的。6 构造器7 方法 这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码3.4 缩进排版4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)，所以在某些编辑器中，需要特别指定一下制表符的长度为4（UltraEdit），而在某些编辑器中，会将制表符转换为空格3.5 行长度尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。3.6 换行当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：-

5、在一个逗号后面断开- 在一个操作符前面断开- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开- 新的一行应该与上一行同一级别表达式的开头处对齐- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。以下是断开方法调用的一些例子：someMethod(longExpression1, longExpression2, longExpression3,longExpression4, longExpression5);$var = someMethod1(longExpression1,someMethod2(longE

6、xpression2,longExpression3);以下是两个断开算术表达式的例子。前者更好，因为断开处位于括号表达式的外边，这是个较高级别的断开。$longName1 = $longName2 * ($longName3 + $longName4 - $longName5)+ 4 * $longname6; /使用这种缩进方式$longName1 = $longName2 * ($longName3 + $longName4- $longName5) + 4 * $longname6; /避免这种以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移

7、得很靠右，所以代之以缩进8个空格/传统的缩进方式function someMethod($anArg, $anotherArg, $yetAnotherArg,$andStillAnother) ./利用8个连续空格避免过渡的缩进function horkingLongMethodName($anArg,$anotherArg, $yetAnotherArg,$andStillAnother) .if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲。比如：/不要使用这种缩进方式if (condition1 & condition2)| (condition3

8、& condition4)|!(condition5 & condition6) /错误的换行方式，没有进行缩进doSomethingAboutIt(); /条件与此句对齐，造成阅读程序时很可能漏过此句/应该使用这种缩进方式if (condition1 & condition2)| (condition3 & condition4)|!(condition5 & condition6) doSomethingAboutIt();/或者这样的缩进方式也可以if (condition1 & condition2) | (condition3 & condition4)|!(condition5 &

9、 condition6) doSomethingAboutIt();这里有三种可行的方法用于处理三元运算表达式：$alpha = (aLongBooleanExpression) ? beta : gamma;$alpha = (aLongBooleanExpression) ? beta: gamma;$alpha = (aLongBooleanExpression)? beta: gamma;4 注释4.1 块注释块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描

10、述的代码具有一样的缩进格式。块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：/* 这里是块注释*/块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。/*-* 如果想被忽略，可是使用特别格式的块注释* one* two* three*/注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。4.2 单行注释短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子：if (con

11、dition) /* 以下代码运行的条件 */.4.3 尾端注释极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。以下是一个代码中尾端注释的例子：if ($a = 2) return TRUE; /* 对单一条件的说明 */ else return isPrime($a); /* 其余的条件 */4.4 行末注释注释界定符/，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：if ($foo 1) / 第二种用法.else

12、return false; / 说明返回值的原因/if ($bar 1) / / 第三种用法/ ./else / return false;/4.5 文档注释文档注释描述php的类、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/*.*/之中，一个注释对应一个类或成员。该注释应位于声明之前：/* 说明这个类的一些 .*/class Example .注意顶层(top-level)的类是不缩进的，而其成员是缩进的。描述类的文档注释的第一行(/*)不需缩进；随后的文档注释每行都缩进1格(使星号纵向对齐)。成员，包括构造函数在内，其文档注释的第一行缩进4格，随后每行都缩进5格

13、。若你想给出有关类、变量或方法的信息，而这些信息又不适合写在文档中，则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如，有关一个类实现的细节，应放入紧跟在类声明后面的实现块注释中，而不是放在文档注释中。文档注释不能放在一个方法或构造器的定义块中，因为程序会将位于文档注释之后的第一个声明与其相关联。5 声明5.1 每行声明的变量数量推荐一行一个声明，因为这样以利于写注释。亦即，int $level; / 缩进的程度int $size; / 由制表符决定要优于，int $level, $size;不要将不同类型变量的声明放在同一行，例如：int $foo, $foo

14、array; /错误注意：上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：int $level; / 缩进的程度int $size; / 由制表符决定$currentEntry; / 通常选择制表符作为缩进的标准5.2 初始化尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。5.3 布局只在代码块的开始处声明变量。（一个块是指任何被包含在大括号和中间的代码。）不要在首次用到该变量时才声明之。这会把注意力不集中的程序员搞糊涂，同时会妨碍代码在该作用域内的可移植性。function myMethod() int $int1

15、= 0; / 方法块的开始if ($condition) int $int2 = 0; / if块的开始.该规则的一个例外是for循环的索引变量for (int $i = 0; i $maxLoops; $i+) . 避免声明的局部变量覆盖上一级声明的变量。例如，不要在内部代码块中声明相同的变量名：int $count;.function myMethod() if ($condition) int $count = 0; / 避免这种声明.5.4 类的声明当编写类时，应该遵守以下格式规则：- 在方法名与其参数列表之前的左括号(间不要有空格- 左大括号位于声明语句同行的末尾- 右大括号另起一行

16、，与相应的声明语句对齐，除非是一个空语句，应紧跟在之后class Sample extends Object int $ivar1;int $ivar2;function Sample(int $i, int $j) ivar$1 = $i;ivar$2 = $j;function emptyMethod() .- 方法与方法之间以空行分隔6 语句6.1 简单的语句每行至多包含一条语句，例如：$argv+; / 正确的$argc-; / 正确的$argv+; $argc-; / 错误的6.2 复合语句复合语句是包含在大括号中的语句序列，形如 语句 。例如下面各段。- 被括其中的语句应该较之复合

17、语句缩进一个层次- 左大括号应位于复合语句起始行的行尾；右大括号应另起一行并与复合语句首行对齐。- 大括号可以被用于所有语句，包括单个语句，只要这些语句是诸如if-else或for控制结构的一部分。这样便于添加语句而无需担心由于忘了加括号而引入bug6.3 返回语句一个带返回值的return语句不使用小括号()，除非它们以某种方式使返回值更为显见。例如：return;return myDisk.size();return ($size ? $size : $defaultSize);6.4 if与else语句if-else语句应该具有如下格式：if (condition) /* 进行操作的条件

18、 */statements;if (condition) /*进行操作的条件. */statements; else /*进行操作的条件*/statements;if (condition) /*进行操作的条件*/statements; else if (condition) /*进行操作的条件 */statements; else/*进行操作的条件*/statements;注意：if语句总是用和括起来，避免使用如下容易引起错误的格式：if (condition) /避免这种写法，他忽略了“”statement;注释格式也可以像下面的这种方式写if (condition) /*进行操作的条件*

19、/statements; else /*进行操作的条件*/statements;只要可以描述清楚各分支之间的关系，在哪里写注释均可6.5 for语句一个for语句应该具有如下格式：for (initialization; condition; update) statements;一个空的for语句(所有工作都在初始化，条件判断，更新子句中完成）应该具有如下格式：for (initialization; condition; update);当在for语句的初始化或更新子句中使用逗号时，避免因使用三个以上变量，而导致复杂度提高。若需要，可以在for循环之前(为初始化子句)或for循环末尾(为更

20、新子句)使用单独的语句。6.6 while语句一个while语句应该具有如下格式while (condition) statements;一个空的while语句应该具有如下格式：while (condition);6.7 do.while语句一个do-while语句应该具有如下格式：do statements; while (condition);6.8 switch语句一个switch语句应该具有如下格式：switch (condition) case ABC:/* falls through */statements;case DEF:statements;break;case XYZ:s

21、tatements;break;default:statements;break;每当一个case顺着往下执行时(因为没有break语句)，通常应在break语句的位置添加注释。上面的示例代码中就包含注释/* falls through */。6.9 try.catch语句一个try-catch语句应该具有如下格式：try statements; catch (ExceptionClass e) statements;一个try-catch语句后面也可能跟着一个finally语句，不论try代码块是否顺利执行完，它都会被执行。try statements; catch (ExceptionCl

22、ass e) statements; finally statements;7 空白7.1 空行空行将逻辑相关的代码段分隔开，以提高可读性。下列情况应该总是使用两个空行：- 一个源文件的两个片段(section)之间- 类声明声明之间下列情况应该总是使用一个空行：- 两个方法之间- 方法内的局部变量和方法的第一条语句之间- 块注释或单行注释之前- 一个方法内的两个逻辑段之间，用以提高可读性7.2 空格下列情况应该使用空格：- 一个紧跟着括号的关键字应该被空格分开，例如：while ( true ) .注意：空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。- 空白应该位于参数

23、列表中逗号的后面- 所有的二元运算符，除了.，应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格，比如：负号(-)、自增(+)和自减(-)。例如：$a += $c + $d;$a = ( $a + $b ) / ( $c * $d );while ( $d+ = $s+ ) $n+;printSize( size is + $foo + n );- for语句中的表达式应该被空格分开，例如：for (expr1; expr2; expr3)- 强制转型后应该跟一个空格，例如：myMethod( (byte) $aNum, (int) $x );myMethod( (int) ($

24、cp + 5 ), ( (int) ($i + 3) + 1 );8 命名规范8.1 命名空间一个唯一命名空间的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。命名空间的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)，也可以按功能模块来分类。8.2 类类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你

25、的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)class Raster;class ImageSprite在为类（class）命名前首先要知道类的功能。如果通过类名的提供的线索，不能准确反映类的功能，那么，命名就是失败的。超过三个词组成的混合名是容易造成系统各个实体间的混淆，尝试使用（CRC Session card)看看该命名所对应的实体是否有着那么多的功用。对于派生类的命名应该避免带其父类名的诱惑，一个类的名字只与它自身有关，和它的父类无关。有时后缀名是有用的，例如：如果你的系统使用了代理（agent），那么就把某个部件命名为“下载代理”（d

26、ownloadAgent）用以真正的传送信息。8.2.1 类属性的命名属性命名应该以字符m为前缀。前缀m后采用于类命名一致的规则。m总是在名字的开头起修饰作用，就像以r开头表示引用一样。理由前缀m防止类属性和方法名发生任何冲突。你的方法名和属性名经常会很类似，特别是存取元素。例如class NameOneTwoint $mVarAbc;int $mErrorNumber;String $mrName;8.3 函数方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。function run();function runFast();function getBac

27、kground();通常每个方法都是执行一个动作的，所以对它的命名应该清楚的说明它是做什么的：用checkForErrors()代替errorCheck()，用dumpDataToFile()代替dataFile()。这么做也可以使功能和数据成为更可区分的物体。有时后缀名是有用的:Max - 含义为某实体所能赋予的最大值。Cnt - 一个运行中的计数变量的当前值。Key - 键值。例如：retryMax 表示最多重试次数，retryCnt 表示当前重试次数。有时前缀名是有用的：is - 含义为问一个关于某样事物的问题。无论何时，当人们看到Is就会知道这是一个问题。get - 含义为取得一个数值。set - 含义为设定一个数值例如：isHitRetryLimit8.4 变量除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。char $c;int $i;float $myWidth;8.5 实例变量大