PHP编码规范

http://tech.ddvip.com   2006年04月08日    社区交流

本文详细介绍PHP编码规范

  2.3. 方法和函数命名

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

  · 有时后缀名是有用的:

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

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

  Key - 键值。

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

  · 有时前缀名是有用的:

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

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

  Set - 含义为设定一个数值

  例如:IsHitRetryLimit。

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

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

  使用: GetHtmlStatistic.

  不使用: GetHTMLStatistic.

  理由

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

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

  例如

  class FluidOz // 不要写成 FluidOZ

  class GetHtmlStatistic // 不要写成 GetHTMLStatistic

  2.5. 类命名

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

  · 名字的首字母使用大写

责编:豆豆技术应用

正在加载评论...