编程命名规则
作为一个编程人员,不管用什么语言编程,写的代码一定要让别人看得懂,命名很关键。
1. 类命名
2. 类属性命名
3. 方法的命名
- 方法的作用都是执行一个动作,达到一个目的。所以名称应该说明方法是做什么的。一般名称的前缀都是有第一规律的,如is(判断)、get(得到),set(设置)。
1
2
3
4
5
6
7
|
class StartStudy{ //类文件都以.class.php为后缀,使用驼峰法命名,首字母大写,不用'_',类名和目录_文件名一致,比如Name、SuperMan、BigClassObject $mLessonOne = "" ; //设置类属性,m打头。后面与类命名一致。 $mLessonTwo = "" ;
function getLessonOne(){ //方法的命名使用驼峰法,首单词首字母小写,后面单词首字母大写。_getResource(),通常下划线开头的方法属于私有方法 ... } function echoWord( $firstWord , $secondWord ){ ... //方法中参数,同方法命名, } } |
4. 方法中参数命名
5. 引用变量
- 引用变量要带有‘r’前缀。如:
1
2
3
4
5
6
7
8
9
|
class Example{ $mExam = "" ; funciton setExam(& $rExam ){ ... } function getExam(){ ... } } |
6. 变量命名
- 所有字母都使用小写。
- 使用‘_’作为每个词的分界。
- 如:$msg_error、$chk_pwd等。
- 临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,s 它们一般用于字符型。
- 实例变量前面需要一个下划线, 首单次小写,其余单词首字母大写。
7. 全局变量
- 全局变量应该带有前缀‘g’。如:global $gTest。
8. 常量、全局常量
- 常量、全局常量,应该全部使用大写字母,单词之间用‘_’来分割。如
1
2
|
define( 'DEFAULT_NUM_AVE' ,90); define( 'DEFAULT_NUM_SUM' ,500); |
9. 静态变量
- 静态变量应该带有前缀‘s’。如:
1
|
state $sStatus = 1; |
10. 函数命名
- 。如:
1
2
3
|
function this_good_idear(){//函数的命名使用小写字母,下划线作分割 ... } |
以上的各种命名规则,可以组合一起来使用,如:
1
2
3
|
class OtherExample{ $msValue = "" ; //该参数既是类属性,又是静态变量 } |