xphp
xphp是一种编码规範(基于php系统),致力于规範化编码,减轻系统后期的维护。
基本介绍
- 中文名:xphp
- 外文名:xphp
创建
xphp由薛友东结合个人经验创建于2016年。
基本命名规则
1.1 通用命名规则
规则1.1.1不得使用汉语拼音
1.2 档案命名规则
规则1.2.1採用单词首字母大写方式(如UserManage)
1.3 类命名规则
规则1.3.1採用单词首字母大写方式(如UserManage)
1.4 函式命名规则
规则1.4.1採用除第一个单词外其他单词首字母大写方式(如userManage)
1.5 变数命名规则
规则1.5.1採用单词之间用下横线方式(如user_manage)
其他命名规则
1.6 常用命名规则
规则1.6.1 foreach命名规则,採用如下方式(data可以为其他名称,键必须为k、k1、k2等,等必须为v、v1、v2等):
foreach ($data as $k => $v) {
foreach ($v as $k1 => $v1) {
$t[$k1][$k]=$v1;
}
}
规则3.6.2 for命名规则,採用如下方式(该变数必须为i、i1):
for ($i=0; $i<8;$i++) {
for ($i1=0; $i1<8;$i1++) {
}
}
规则1.6.3函式返回值命名规则(内部接口,只限增、删、改数据操作的函式),採用如下方式(函式的返回值变数必须为$ ret,其中$ ret["res"]是返回的值,$ ret["msg"]是出错信息):
public function addUser(){
…
$data=…
$ret["res"]=$data;
$ret["msg"]="操作失败!";
return $ret;
}
规则1.6.4 使用少于4次的变数,该变数统一命名为$temp(除上面特定情况外)
规则1.6.5 单双引号使用方式,优先使用双引号(如$ret["msg"] ="操作失败!";、$a=eavl('$ ret ["msg"] ="操作失败!";')),特殊情况可以例外(如sql语句中字元串必须用单引号)
规则1.6.6 新增数据的方法名以add开头,更新数据的方法名以edit开头,删除数据的方法名以remove开头
资料库命名
1.7 资料库的命名规则
规则1.7.1 资料库名採用单词之间用下横线方式(如user_manage)
规则1.7.1 表名採用单词之间用下横线方式(如user_manage)
规则1.7.1 栏位名採用单词之间用下横线方式(如user_manage)