编码规范
时间:2007-04-15 来源:lib
每个团队都需要有统一的编码规范.
1.注释
2.缩进 四个空格为一级,
3.if,while,for等代码块用哪种大括号包围,(顶尾/换行)
统一使用
if($true){
// do some
}
4.命名规范
(1)类,以大写字母开头,一简洁的名词来做做类名,每个字母都一大写开头.使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML) .
属性: private型 用$_打头,别的范围类型使用变量命名规则,类常量用一般常量命名规则
方法: private型 用$_打头,别的范围类型使用函数命名规则,不带有和类名一样的字样,
方法名是一个动词.通常每个方法都是执行一个动作的,所以对它的命名应该清楚的说明它是做什么的:用checkForErrors()代替errorCheck(),用dumpDataToFile()代替dataFile()。这么做也可以使功能和数据成为更可区分的物体。
有时后缀名是有用的:
Max - 含义为某实体所能赋予的最大值。
Cnt - 一个运行中的计数变量的当前值。
Key -
键值。
例如:retryMax 表示最多重试次数,retryCnt 表示当前重试次数。
有时前缀名是有用的:
is - 含义为问一个关于某样事物的问题。无论何时,当人们看到Is就会知道这是一个问题。
get -
含义为取得一个数值。
set - 含义为设定一个数值
例如:isHitRetryLimit
(2)函数 使用骆驼法则,比如mysqlConnect(),以区别库函数的mysql_connet().一个名词后加动词,什么东西要做什么.
(3)变量 骆驼法则,变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。
(4)实例 以$_开始,别的与变量一样
(5)常量 全不是大写,单词间用"_"隔开, MY_CONST
(6)文件 骆驼法则,如果是类文件,则以大写字母打头,否则一小写字母开头
5.脚本中使用哪中错误处理和异常处理
6.如何包含其他文件或脚本
7.类的结构
8.文件结构
9.编程惯例
相关阅读 更多 +
排行榜 更多 +