变量命名规则

作为程序员,我知道有好几种变量命名的规范,但一直以来都没有认真去遵守,总以很随意地定义变量,或者混乱地使用多种定义规则.以致在看回以前的程序时(甚至有时开发过程中)会造成不必要的麻烦,于是定义本规则,作为自己以后开发中的标准.

 

类(Class):

 

类名首字母大写,如果需要用多个单词,则每个单词的首字母大写,每个单词间直接相连不分隔.而且,第一单词为名词,第二单词为动词.如:

MovieEdit,CarShow

一般地,类名与文件名相同.如果项目比较复杂时,可用类名中加上目录结构,用下划线分隔每层目录,最后才是类名,如:

Model_MovieEdit

 

方法(function):

 

方法(或函数)名使用小写字母,如果有多个单词,则除第一个单词外,其余每个单词首字母大写,单词间不分隔,一般地,第一个单词为动词,如get,add,edit等,第二个单词为名语,返回多行值时,一般用复数,如:

getName,editDatas

 

变量(variable):

 

使用小写字母,除第一个单词外,其余每个单词首字母大写,单词间不分隔.一般为名词,或修饰词+名词,需要时,使用复数,并使用类型后缀,如Int,Num,Obj等,例:

myName,age,carObj

 

常量(const):

 

全部大写字母,每个单词间用下划线分隔,必要时,同类形常量使用同一前缀.

 

数据库(DB):

 

数据表名及字段名均采用小写字母,并使用下划线分隔每个单词,如果为外键,一般为连接的表名+连接的字段, 应保证不使用系统保留字作字段名,一般地,对应某个项目,表名使用同一简短前缀,如:

tb_content(id,title,content)

tb_summary(id,table_content_id,add_time,user)

 

其它:

1)文件名命名,除类文件使用大写字母开头,其它均采用小写开头,以后单词首字母大写.除配置文件使用.inc.php作为后缀,一般采用表明文件作用的单词作名字,并直接使用.php后缀.

2)HTML表单中的变量命名,尽量与数据表字段一致

3)js文件变量亦使用以上提到的规则