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)

相關詞條

熱門詞條

聯絡我們