没有合适的资源?快使用搜索试试~ 我知道了~
PHP编码规范.doc
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 190 浏览量
2023-01-11
15:41:46
上传
评论
收藏 106KB DOC 举报
温馨提示
试读
25页
开发语言编码规范
资源推荐
资源详情
资源评论
编 号:MPDK/ZY-16-2007
修 改 号:0
计算机源代码编写规范(PHP 编码规范)
发 放 号:
发布时间:2007-06-28
实施时间:2007-06-28
编 制:
批 准:
PHP 编码规范
PHP 编码规范 ..................................................................................................................................1
1 目的 ..........................................................................................................................................1
2 适用范围 .................................................................................................................................1
3 规范内容 .................................................................................................................................1
1 目的
规范 PHP 代码编写人员的编程工作。
2 适用范围
适合本公司所有 PHP 代码编写人员使用。
3 规范内容
3.1 项目的四个阶段 :
数据库结构
设计
数据层
HTML 层
3.2 命名规则
3.2.1 类命名
在为类(class )命名前首先要知道它是什么。如果通过类名的提供的
线索,你还是想不起这个类是什么的话,那么你的设计就还做的不够好。
超过三个词组成的混合名是容易造成系统各个实体间的混淆,再看看你
的设计,尝试使用(CRC Session card)看看该命名所对应的实体是否有着那
么多的功用。
对于派生类的命名应该避免带其父类名的诱惑,一个类的名字只与它自
身有关,和它的父类叫什么无关。
有时后缀名是有用的,例如:如果你的系统使用了代理(agent ),那
么就把某个部件命名为“下载代理”(DownloadAgent)用以真正的传送信息。
3.2.2 方法和函数命名
通常每个方法和函数都是执行一个动作的,所以对它们的命名应该清楚
的 说 明 它 们 是 做 什 么 的 : 用 CheckForErrors() 代 替 ErrorCheck () , 用
DumpDataToFile()代替 DataFile()。这么做也可以使功能和数据成为更可区分
的物体。
有时后缀名是有用的:
Max - 含义为某实体所能赋予的最大值。
Cnt - 一个运行中的计数变量的当前值。
Key - 键值。
例如:RetryMax 表示最多重试次数,RetryCnt 表示当前重试次数。
有时前缀名是有用的:
Is - 含义为问一个关于某样事物的问题。无论何时,当人们看到 Is 就会
知道这是一个问题。
Get - 含义为取得一个数值。
Set - 含义为设定一个数值
例如:IsHitRetryLimit。
缩写词不要全部使用大写字母
无论如何,当遇到以下情况,你可以用首字母大写其余字母小写来代替
全部使用大写字母的方法来表示缩写词。
使用: GetHtmlStatistic.
不使用: GetHTMLStatistic.
理由
当命名含有缩略词时,人们似乎有着非常不同的直觉。统一规定是最好,
这样一来,命名的含义就完全可以预知了。
举个 NetworkABCKey 的例子,注意 C 是应该是 ABC 里面的 C 还是 key 里
面的 C,这个是很令人费解的。有些人不在意这些,其他人却很讨厌这样。
所以你会在不同的代码里看到不同的规则,使得你不知道怎么去叫它。
例如
class FluidOz // 不要写成 FluidOZ
class GetHtmlStatistic // 不要写成 GetHTMLStatistic
3.2.3 类库命名
目前命名空间正在越来越广泛的被采用,以避免不同厂商和团体类库间
的类名冲突。
当尚未采用命名空间的时候,为了避免类名冲突,一般的做法是在类名
前加上独特的前缀,两个字符就可以了,当然多用一些会更好。
例如
John Johnson 的数据结构类库可以用 Jj 做为前缀,如下:
class JjLinkList
{
}
另一种折中方式是建立包含类库目录(事实上 Java 也是这么做的),以
不通的目录代表不同的命名空间。
例如
Microsoft 的数据库相关类库可以在:
/classes/com/Microsoft/ Database/DbConn.php
Apache 的数据库相关类库可在:
/classes/org/apache/Database/DbConn.php
3.2.4 方法命名
采用与类命名一致的规则
理由:使用所有不同规则的大部分人发现这是最好的折衷办法。
例如
class NameOneTwo
{
function DoIt() {};
function HandleError() {};
}
3.2.5 类属命名
属性命名应该以字符‘m’为前缀。
前缀‘m’后采用于类命名一致的规则。
‘m’总是在名字的开头起修饰作用,就像以‘r’开头表示引用一样。
理由:前缀'm'防止类属性和方法名发生任何冲突。你的方法名和属性名
经常会很类似,特别是存取元素。
例如
class NameOneTwo
{
function VarAbc() {};
function ErrorNumber() {};
var $mVarAbc;
var $mErrorNumber;
var $mrName;
}
3.2.6 方法中参数命名
第一个字符使用小写字母。
在首字符后的所有字都按照类命名规则首字符大写。
理由:可以区分方法中的一般变量,你可以使用与类名相似的名称而不至于
产生重名冲突。
例如
class NameOneTwo
{
function StartYourEngines(
&$rSomeEngine,
&$rAnotherEngine);
}
3.2.7 变量命名
所有字母都使用小写
使用'_'作为每个词的分界。
理由:通过这一途径,代码中变量的作用域是清晰的,所有的变量在代
码中都看起来不同,容易辨认。
例如
function HandleError($errorNumber)
{
$error = OsErr($errorNumber);
$time_of_error = OsErr->GetTimeOfError();
$error_processor = OsErr->GetErrorProcessor();
}
3.2.8 引用变量和函数返回引用
剩余24页未读,继续阅读
资源评论
悠闲饭团
- 粉丝: 151
- 资源: 3303
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功