php coding standard(2)

例如:RetryMax 表示最多重试次数,RetryCnt 表示当前重试次数。 有时前缀名是有用的: Is - 含义为问一个关于某样事物的问题。无论何时,当人们看到Is就会知道这是一个问题。 Get - 含义为取得一个数值。 Set - 含义为设定一个数值

例如:IsHitRetryLimit。

缩写词不要全部使用大写字母 无论如何,当遇到以下情况,你可以用首字母大写其余字母小写来代替全部使用大写字母的方法来表
示缩写词。

使用: GetHtmlStatistic.
不使用: GetHTMLStatistic.
理由 当命名含有缩略词时,人们似乎有着非常不同的直觉。统一规定是最好,这样一来,命名的含义就完
全可以预知了。

举个NetworkABCKey的例子,注意C是应该是ABC里面的C还是key里面的C,这个是很令人费解的。有些
人不在意这些,其他人却很讨厌这样。所以你会在不同的代码里看到不同的规则,使得你不知道怎么
去叫它。

例如 class FluidOz // 不要写成 FluidOZ class GetHtmlStatistic // 不要写成 GetHTMLStatistic

类命名 使用大写字母作为词的分隔,其他的字母均使用小写 名字的首字母使用大写 不要使用下划线('_') 理由 根据很多的命名方式,大部分人认为这样是最好的方式。 例如 class NameOneTwo class Name

类库命名 目前命名空间正在越来越广泛的被采用,以避免不同厂商和团体类库间的类名冲突。

当尚未采用命名空间的时候,为了避免类名冲突,一般的做法是在类名前加上独特的前缀,两个字符就
可以了,当然多用一些会更好。 例如John Johnson的数据结构类库可以用Jj做为前缀,如下: class JjLinkList { }

方法命名 采用与类命名一致的规则 理由 使用所有不同规则的大部分人发现这是最好的折衷办法。 例如 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(); $time_of_error = OsErr->getTimeOfError; $error_processor = OsErr->getErrorProcessor; }

引用变量和函数返回引用 引用必须带‘r'前缀 理由 使得类型不同的变量容易辨认 它可以确定哪个方法返回可更改对象,哪个方法返回不可更改对象。 例如 class Test { var mrStatus;
function DoSomething(&$rStatus) {}; function &rStatus() {}; }

全局变量 全局变量应该带前缀‘g'。 理由 知道一个变量的作用域是非常重要的。 例如 global $gLog; global &$grLog;

定义命名 / 全局常量 全局常量用'_'分隔每个单词。 理由这是命名全局常量的传统。你要注意不要与其它的定义相冲突。 例如
define("A_GLOBAL_CONSTANT", "Hello world!"); 静态变量 静态变量应该带前缀‘s'。 理由 知道一个变量的作用域是非常重要的。 例如function test()
{
static $msStatus = 0; }

函数命名 函数名字采用C GNU的惯例,所有的字母使用小写字母,使用'_'分割单词。 理由 这样可以更易于区分相关联的类名。 例如function some_bloody_function() { }

错误返回检测规则 检查所有的系统调用的错误信息,除非你要忽略错误。 为每条系统错误消息定义好系统错误文本以便include。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/b9a3222ea7d2c3391fe0d2fa546484b8.html