17joys项目代码的命名规范
时间:2010-04-14 来源:17joys
http://www.17joys.com/php/cms/cms-6-83.html17joys项目代码的命名规范
每个项目都会有相关的开发文档,其中一个非常有用的文档就是代码编写规范。
下面是使用ThinkPHP应该尽量遵循的命名规范,请大家编写时务必注意,养成良好的代码编写习惯是做好一个程序员非常关键的一步:
- 类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如DbMysql.class.php。
- 函数、配置文件等其他类库文件之外的一般是以.php为后缀(第三方引入的不做要求)。
- 确保文件的命名和调用大小写一致,是由于在类Unix系统上面,对大小写是敏感的(而ThinkPHP在调试模式下面,即使在Windows平台也会严格检查大小写)。
- 类名和文件名一致(包括上面说的大小写一致),例如 UserAction类的文件命名是UserAction.class.php, InfoModel类的文件名是InfoModel.class.php,
- 函数的命名使用小写字母和下划线的方式,例如 get_client_ip
- Action控制器类以Action为后缀,例如 UserAction、InfoAction
- 模型类以Model为后缀,例如UserModel、InfoModel
- 方法的命名使用驼峰法,并且首字母小写,例如 getUserName
- 属性的命名使用驼峰法,并且首字母小写,例如 tableName
- 以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload
- 常量以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY
- 配置参数以大写字母和下划线命名,例如HTML_CACHE_ON
- 语言变量以大写字母和下划线命名,例如MY_LANG,以下划线打头的语言变量通常用于系统语言变量,例如 _CLASS_NOT_EXIST_。
- 数据表和字段采用小写加下划线方式命名,例如 think_user 和 user_name
另外一点,ThinkPHP默认使用UTF-8编码,所以请确保你的程序文件采用UTF-8编码格式保存,并且去掉BOM信息头(去掉BOM头信息有很多方式,不同的编辑器都有设置方法,也可以用工具进行统一检测和处理)。
作者:马明@PHP培训 修订1.0 2010-03
乐学PHP学院是国内专业的PHP培训机构,天津最好的PHP培训机构,拥有完整全面的PHP培训课程体系,使用自行开发的PHP内容管理系统作为授课案例,真实项目教学,还提供PHP教程、PHP视频、PHP人才、PHP开发等服务!
本文乐学PHP版权所有,未经批准转载必究。
相关阅读 更多 +