PHP 编程规约.pdf

PHP 编程规约 1、命名规则 2、控制结构 3、函数调用 4、函数定义 5、缩进/制表符/空格规则 6、关于注释 6、包含代码 7、PHP代码标记 8、文件头的注释声明 9、文件结尾部分注释 10、PHP 文件扩展名 11、使用 CVS 命名规则 类命名 ·在为类 （class ）命名前首先要知道它是什么。如果通过类名的提供的线索，你还是想不起这个类是什么 的话，那么你的设计就还做的不够好。 ·超过三个词组成的混合名是容易造成系统各个实体间的混淆，再看看你的设计，尝试使用 （CRC Session card)看看该命名所对应的实体是否有着那么多的功用。 ·对于派生类的命名应该避免带其父类名的诱惑，一个类的名字只与它自身有关，和它的父类叫什么无关。 ·有时后缀名是有用的，例如：如果你的系统使用了代理（agent ），那么就把某个部件命名为 “下载代理” （DownloadAgent）用以真正的传送信息。 ·使用大写字母作为词的分隔，其他的字母均使用小写 ·名字的首字母使用大写 ·不要使用下划线(_) 理由 ·根据很多的命名方式，大部分人认为这样是最好的方式。 例如 class NameOneTwo class Name 方法和函数命名 ·通常每个方法和函数都是执行一个动作的，所以对它们的命名应该清楚的说明它们是做什么的：用 CheckForErrors()代替ErrorCheck()，用DumpDataToFile()代替DataFile()。这么做也可以使功能和数据 成为更可区分的物体。 ·有时后缀名是有用的: o Max - 含义为某实体所能赋予的最大值。 o Cnt - 一个运行中的计数变量的当前值。 o Key - 键值。 例如：RetryMax 表示最多重试次数，RetryCnt 表示当前重试次数。 ·有时前缀名是有用的： o Is - 含义为问一个关于某样事物的问题。无论何时，当人们看到Is就会知道这是一个问题。 o Get - 含义为取得一个数值。 o Set - 含义为设定一个数值 例如：IsHitRetryLimit。 缩写词不要全部使用大写字母 ·无论如何，当遇到以下情况，你可以用首字母大写其余字母小写来代替全部使用大写字母的方法来表示缩 写词。 使用: GetHtmlStatistic. 不使用: GetHTMLStatistic. 方法命名 ·采用与类命名一致的规则 理由 ·使用所有不同规则的大部分人发现这是最好的折衷办法。 例如 class NameOneTwo { function DoIt() {}; function HandleError() {}; } 类属性命名 ·属性命名应该以字符 ‘m’为前缀。 ·前缀 ‘m’后采用于类命名一致的规则。 · ‘m’总是在名字的开头起修饰作用，就像以 ‘r’开头表示引用一样。 理由 ·前缀m防止类属性和方法名发生任何冲突。你的方法名和属性名经常会很类似，特别是存取元素。 例如 class NameOneTwo { function VarAbc() {}; function ErrorNumber() {}; var $mVarAbc; var $mErrorNumber; var $mrName; } 方法中参数命名 ·第一个字符使用小写字母。 ·在首字符后的所有字都按照类命名规则首字符大写。 理由 ·可以区分方法中的一般变量。 ·你可以使用与类名相似的名称而不至于产生重名冲突。 例如 class NameOneTwo { function StartYourEngines( $rSomeEngine, $rAnotherEngine); } 变量命名 ·所有字母都使用小写 ·使用_作为每个词的分界。 理由 ·通过这一途径，代码中变量的作用域是清晰的。 ·所有的变量在代码中都看起来不同，容易辨认。 例如 function HandleError($errorNumber) { $error OsErr($errorNumber); $time_of_error OsErr-GetTimeOfError(); $error_processor OsErr-GetErrorProcessor(); } 全局变量 ·全局变量应该带前缀 ‘g’。 理由 ·知道一个变量的作用域是非常重要的。 例如 global $gLog