快速业务通道

关于PHP开发编码规范

作者 佚名技术 来源 NET编程 浏览 发布时间 2012-05-23
做的不够好。 

· 超过三个词组成的混合名是容易造成系统各个实体间的混淆,再看看你的设计,尝试使用(CRC Session card)看看该命名所对应的实体是否有着那么多的功用。 

· 对于派生类的命名应该避免带其父类名的诱惑,一个类的名字只与它自身有关,和它的父类叫什么无关。 

· 有时后缀名是有用的,例如:如果你的系统使用了代理(agent ),那么就把某个部件命名为“下载代理”(DownloadAgent)用以真正的传送信息。 

 

2.3. 方法和函数命名 

 

· 通常每个方法和函数都是执行一个动作的,所以对它们的命名应该清楚的说明它们是做什么的:用CheckForErrors()代替ErrorCheck(),用DumpDataToFile()代替DataFile()。这么做也可以使功能和数据成为更可区分的物体。 

· 有时后缀名是有用的: 

o Max - 含义为某实体所能赋予的最大值。 

o Cnt - 一个运行中的计数变量的当前值。 

o Key - 键值。 

例如:RetryMax 表示最多重试次数,RetryCnt 表示当前重试次数。 

· 有时前缀名是有用的: 

o Is - 含义为问一个关于某样事物的问题。无论何时,当人们看到Is就会知道这是一个问题。 

o Get - 含义为取得一个数值。 

o Set - 含义为设定一个数值 

例如:IsHitRetryLimit。 

 

2.4. 缩写词不要全部使用大写字母 

 

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

使用: GetHtmlStatistic. 

不使用: GetHTMLStatistic. 

理由 

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

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

例如 

class FluidOz // 不要写成 FluidOZ 

class GetHtmlStatistic // 不要写成 GetHTMLStatistic 

 

2.5. 类命名 

 

· 使用大写字母作为词的分隔,其他的字母均使用小写 

· 名字的首字母使用大写 

· 不要使用下划线(_) 

理由 

· 根据很多的命名方式,大部分人认为这样是最好的方式。 

例如 

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. 类属

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢!

分享到: 更多

Copyright ©1999-2011 厦门凌众科技有限公司 厦门优通互联科技开发有限公司 All rights reserved

地址(ADD):厦门软件园二期望海路63号701E(东南融通旁) 邮编(ZIP):361008

电话:0592-5908028 传真:0592-5908039 咨询信箱:web@lingzhong.cn 咨询OICQ:173723134

《中华人民共和国增值电信业务经营许可证》闽B2-20100024  ICP备案:闽ICP备05037997号