02.3. 命名规范

目录和文件

目录使用小写+下划线;
类库、函数文件统一以.php为后缀;
类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致;
类文件采用驼峰法命名(首字母大写),其它文件采用小写+下划线命名;
类名和类文件名保持一致,统一采用驼峰法命名(首字母大写);

函数和类、属性命名

类的命名采用驼峰法(首字母大写),例如 User、UserType,默认不需要添加后缀,例如UserController应该直接命名为User;
函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip;
方法的命名使用驼峰法(首字母小写),例如 getUserName;
属性的命名使用驼峰法(首字母小写),例如 tableName、instance;
以双下划线“__”打头的函数或方法作为魔术方法,例如 __call 和 __autoload;

常量和配置

常量以大写字母和下划线命名,例如 APP_PATH和 WEB_PATH;
配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert;

数据表和字段

数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 oa_user 表和 user_name字段,不建议使用驼峰和中文作为数据表字段命名。

项目目录结构

E:\qh\code\app\
E:\qh\code\app\a9\
E:\qh\code\app\app\
E:\qh\code\app\appman\
E:\qh\code\app\blacklist\
E:\qh\code\app\coder\
E:\qh\code\app\crm\
E:\qh\code\app\cti\
E:\qh\code\app\demos\
E:\qh\code\app\exam\
E:\qh\code\app\fox\
E:\qh\code\app\lead\
E:\qh\code\app\mics\
E:\qh\code\app\oa\
E:\qh\code\app\pds\
E:\qh\code\app\px\
E:\qh\code\app\sea\
E:\qh\code\app\study\
E:\qh\code\app\ucenter\
E:\qh\code\app\wechat\
E:\qh\code\app\weixin\
E:\qh\code\app\wms\
E:\qh\code\app\www\
E:\qh\code\app\x5\
E:\qh\code\app\xapp\
E:\qh\code\app\xfile\
E:\qh\code\app\xim\
E:\qh\code\app\xrights\
E:\qh\code\app\xshop\
E:\qh\code\app\yeah\
E:\qh\code\app\config.php  # 配置文件
E:\qh\code\cache\
E:\qh\code\code\
E:\qh\code\common\
E:\qh\code\crm\
E:\qh\code\demo\
E:\qh\code\eupload\ #同步远程或者发布服务器
E:\qh\code\fox\
E:\qh\code\logs\
E:\qh\code\mics\
E:\qh\code\mics\appman\
E:\qh\code\mics\bus\
E:\qh\code\mics\crm\
E:\qh\code\mics\demo\
E:\qh\code\mics\docker\
E:\qh\code\mics\erp\
E:\qh\code\mics\exam\
E:\qh\code\mics\flow\
E:\qh\code\mics\im\
E:\qh\code\mics\jober\
E:\qh\code\mics\logs\
E:\qh\code\mics\oa\
E:\qh\code\mics\oss\ # oss文件服务
E:\qh\code\mics\sms\ # sms短信服务
E:\qh\code\mics\ucenter\ # ucenter用户中心
E:\qh\code\mics\view\
E:\qh\code\mics\xapp\
E:\qh\code\mics\appx.php
E:\qh\code\mics\help.html
E:\qh\code\mics\index.php
E:\qh\code\pds\
E:\qh\code\sea\
E:\qh\code\three\
E:\qh\code\tools\ # 客户端浏览器
E:\qh\code\ui\ # 前端代码
E:\qh\code\Upload\
E:\qh\code\web\
E:\qh\code\wiki\
E:\qh\code\www\
E:\qh\code\记录\
E:\qh\code\文档库\
E:\qh\code\.htaccess
E:\qh\code\~runtime.php # 运行lib
E:\qh\code\check.json
E:\qh\code\dingXXX.php
E:\qh\code\favicon.ico
E:\qh\code\getip.php
E:\qh\code\index.php
E:\qh\code\svn.php
E:\qh\code\svn1.php
E:\qh\code\svn2.php