· 通常每个方法和函数都是执行一个动作的,所以对它们的命名应该清楚的说明它们是做什么的:用CheckForErrors()代替ErrorCheck(),用DumpDataToFile()代替DataFile()。这么做也可以使功能和数据成为更可区分的物体。 · 有时后缀名是有用的: o Max - 含义为某实体所能赋予的最大值。 o Cnt - 一个运行中的计数变量的当前值。 o Key - 键值。 例如:RetryMax 表示最多重试次数,RetryCnt 表示当前重试次数。 · 有时前缀名是有用的: o Is - 含义为问一个关于某样事物的问题。无论何时,当人们看到Is就会知道这是一个问题。 o Get - 含义为取得一个数值。 o Set - 含义为设定一个数值 例如:IsHitRetryLimit。
· 使用大写字母作为词的分隔,其他的字母均使用小写 · 名字的首字母使用大写 · 不要使用下划线('_') 理由 · 根据很多的命名方式,大部分人认为这样是最好的方式。 例如 class NameOneTwo class Name
2.6. 类库命名
· 目前命名空间正在越来越广泛的被采用,以避免不同厂商和团体类库间的类名冲突。 · 当尚未采用命名空间的时候,为了避免类名冲突,一般的做法是在类名前加上独特的前缀,两个字符就可以了,当然多用一些会更好。 例如 John Johnson的数据结构类库可以用Jj做为前缀,如下: class JjLinkList { } 另一种折中方式是建立包含类库目录(事实上Java也是这么做的),以不通的目录代表不同的命名空间。 例如 Microsoft的数据库相关类库可以在: /classes/com/Microsoft/ Database/DbConn.php Apache的数据库相关类库可在: /classes/org/apache/Database/DbConn.php
2.7. 方法命名
· 采用与类命名一致的规则 理由 · 使用所有不同规则的大部分人发现这是最好的折衷办法。 例如 class NameOneTwo { function DoIt() {}; function HandleError() {}; }
2.8. 类属**命名
· 属**命名应该以字符‘m’为前缀。 · 前缀‘m’后采用于类命名一致的规则。 · ‘m’总是在名字的开头起修饰作用,就像以‘r’开头表示引用一样。 理由 · 前缀'm'防止类属**和方法名发生任何冲突。你的方法名和属**名经常会很类似,特别是存取元素。 例如 class NameOneTwo { function VarAbc() {}; function ErrorNumber() {}; var $mVarAbc; var $mErrorNumber; var $mrName; }
2.9. 方法中参数命名
· 第一个字符使用小写字母。 · 在首字符后的所有字都按照类命名规则首字符大写。 理由 · 可以区分方法中的一般变量。 · 你可以使用与类名相似的名称而不至于产生重名冲突。 例如 class NameOneTwo { function StartYourEngines( &$rSomeEngine, &$rAnotherEngine); }
· 引用必须带‘r’前缀 理由 · 使得类型不同的变量容易辨认 · 它可以确定哪个方法返回可更改对象,哪个方法返回不可更改对象。 例如 class Test { var mrStatus; function DoSomething(&$rStatus) {}; function &rStatus() {}; }
2.12. 全局变量
· 全局变量应该带前缀‘g’。 理由 · 知道一个变量的作用域是非常重要的。 例如 global $gLog; global &$grLog;
while ($a != ($c = getchar())) { process the character } ++和--操作符类似于赋值语句。因此,出于许多的目的,在使用函数的时候会产生副作用。使用嵌入式赋值提高运行时**能是可能的。无论怎样,程序员在使用嵌入式赋值语句时需要考虑在增长的速度和减少的可维护**两者间加以权衡。例如:
关键字 含义 Purpose 表示类、属**、方法要做些什么或者什么含义。 Package Name 类名 Author 作者 Modifications 修改记录(编号规则为“No”+日期+“-”+序号) See 参考 Method Name 方法名 Parameter 参数名(包括类型) Return 返回值(包括类型) Attribute/Variable Name 属**/变量名 Type 属**/变量类型
有时需要注释大段的测试代码,最简单的方法就是使用if (0)块: function example() { great looking code
if (0) { lots of code }
more code } 你不能使用/**/,因为注释内部不能包含注释,而大段的程序中可以包含注释。
5.3.6. 目录文档
所有的目录下都需要具有README文档,其中包括: · 该目录的功能及其包含内容 · 一个对每一文件的在线说明(带有link),每一个说明通常还应该提取文件标头的一些属**名字。 · 包括设置、使用说明 · 指导人们如何连接相关资源: o 源文件索引 o 在线文档 o 纸文档 o 设计文档 · 其他对读者有帮助的东西 考虑一下,当每个原有的工程人员走了,在6个月之内来的一个新人,那个孤独受惊吓的探险者通过整个工程的源代码目录树,阅读说明文件,源文件的标头说明等等做为地图,他应该有能力穿越整个工程。