使用ThinkPHP开发命名规范
2012-02-20 16:34
211 查看
使用ThinkPHP开发的过程中应该尽量遵循下列命名规范:
²
类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如DbMysql.class.php;
²
确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写);
²
类名和文件名一致(包括上面说的大小写一致),例如
UserAction类的文件命名是UserAction.class.php, InfoModel类的文件名是InfoModel.class.php,
并且不同的类库的类命名有一定的规范;
²
函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求);
²
函数的命名使用小写字母和下划线的方式,例如 get_client_ip;
²
方法的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 getUserName,_parseType,通常下划线开头的方法属于私有方法;
²
属性的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 tableName、_instance,通常下划线开头的属性属于私有属性;
²
以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload;
²
常量以大写字母和下划线命名,例如 HAS_ONE和
MANY_TO_MANY;
²
配置参数以大写字母和下划线命名,例如HTML_CACHE_ON;
²
语言变量以大写字母和下划线命名,例如MY_LANG,以下划线打头的语言变量通常用于系统语言变量,例如
_CLASS_NOT_EXIST_;
²
对变量的命名没有强制的规范,可以根据团队规范来进行;
² ThinkPHP的模板文件默认是以.html
为后缀(可以通过配置修改);
²
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user
表和 user_name字段,类似 _username
这样的数据表字段可能会被过滤。
特例:在ThinkPHP里面,有一个函数命名的特例,就是单字母大写函数,这类函数通常是某些操作的快捷定义,或者有特殊的作用。例如,ADSL方法等等,他们有着特殊的含义,后面会有所了解。
另外有一点非常关键,ThinkPHP默认全部使用UTF-8编码,所以请确保你的程序文件采用UTF-8编码格式保存,并且去掉BOM信息头(去掉BOM头信息有很多方式,不同的编辑器都有设置方法,也可以用工具进行统一检测和处理),否则可能导致很多意想不到的问题。
²
类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如DbMysql.class.php;
²
确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写);
²
类名和文件名一致(包括上面说的大小写一致),例如
UserAction类的文件命名是UserAction.class.php, InfoModel类的文件名是InfoModel.class.php,
并且不同的类库的类命名有一定的规范;
²
函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求);
²
函数的命名使用小写字母和下划线的方式,例如 get_client_ip;
²
方法的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 getUserName,_parseType,通常下划线开头的方法属于私有方法;
²
属性的命名使用驼峰法,并且首字母小写或者使用下划线“_”,例如 tableName、_instance,通常下划线开头的属性属于私有属性;
²
以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload;
²
常量以大写字母和下划线命名,例如 HAS_ONE和
MANY_TO_MANY;
²
配置参数以大写字母和下划线命名,例如HTML_CACHE_ON;
²
语言变量以大写字母和下划线命名,例如MY_LANG,以下划线打头的语言变量通常用于系统语言变量,例如
_CLASS_NOT_EXIST_;
²
对变量的命名没有强制的规范,可以根据团队规范来进行;
² ThinkPHP的模板文件默认是以.html
为后缀(可以通过配置修改);
²
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user
表和 user_name字段,类似 _username
这样的数据表字段可能会被过滤。
特例:在ThinkPHP里面,有一个函数命名的特例,就是单字母大写函数,这类函数通常是某些操作的快捷定义,或者有特殊的作用。例如,ADSL方法等等,他们有着特殊的含义,后面会有所了解。
另外有一点非常关键,ThinkPHP默认全部使用UTF-8编码,所以请确保你的程序文件采用UTF-8编码格式保存,并且去掉BOM信息头(去掉BOM头信息有很多方式,不同的编辑器都有设置方法,也可以用工具进行统一检测和处理),否则可能导致很多意想不到的问题。
相关文章推荐
- 从" ThinkPHP 开发规范 "看 PHP 的命名规范和开发建议
- 从" ThinkPHP 开发规范 "看 PHP 的命名规范和开发建议
- thinkphp3.2开发排错一例——没有使用命名空间导致没有自动加载类进而导致Class not found
- Android开发规范之------Android 资源文件命名与使用
- Android程序员学PHP开发(32)-ThinkPHP5.0(4)命名空间与公共空间-PhpStorm
- Android程序员学PHP开发(33)-ThinkPHP5.0(5)命名空间与TP5-PhpStorm
- C#开发命名规范
- 使用struts、hibernate、spring进行框架整合流程详细说明(完整版)附:开发规范
- iOS开发之OC命名规范和编码规范(持续更新)
- 开发命名规范
- 北京天宇联科技有限责任公司—T语言Ios开发命名规范
- 蓝牙、WIFI、无线模块的使用规范及开发指南
- 使用ThinkPHP框架高速开发站点(多图)
- MySQL开发规范与使用技巧总结
- Android开发命名规范
- 使用Thinkphp框架开发移动端接口
- IOS开发编码及命名规范
- Android开发规范——命名
- 开发中SVN使用规范
- 开发命名规范