PHP程式設計風格規範分享
本規範由 EasyChen 借鑑 SINA網路應用開發部《C++開發規範》和互動技術部《PHP4開發規範》,以及phpDocument規範 整理出的開發規範。我覺得非常不錯, 適合PHP的開發,給大家參考,養成一個良好的程式設計風格是非常有必要的。
說明:本規範由 EasyChen 借鑑 SINA網路應用開發部《C++開發規範》和互動技術部《PHP4開發規範》,以及phpDocument規範 整理出的開發規範。我覺得非常不錯, 適合PHP的開發,給大家參考,養成一個良好的程式設計風格是非常有必要的。
第1章 命名規範
1.1變數
1.1.1全域性變數
全域性變數使用$g_開頭,如$g_data_list。
1.1.2 一般變數
一般的變數使用小寫字母命名,單詞之間使用下劃線分隔。
變數名字應該使用名詞或者形容詞+名詞的方式。如$value,$new_value。
1.1.3 臨時變數
不要將在迴圈中頻繁使用的臨時變數如$i、$j等用於其它用途。
1.2 函式
函式採用小寫字母命名,單詞之間使用下劃線分隔。
函式的命名建議使用動詞+名詞的`方式,如get_user_img。
完成一組功能的函式放到一個檔案中,存放函式的檔案採用function_命名。
1.3 類
類使用英文的大小寫來分隔單詞,包括首個單詞,所有單詞的首字母大寫,如PageManager;
在類中,方法放到屬性定義前邊、公用方法放到專用方法前邊;
一般情況下,一個類對應到一個檔案;
當一些類關係緊密時,可以存放在一個檔案中;
存放類的檔案採用方式命名。
1.4 方法
方法使用英文的大小寫來分隔單詞,除首個單詞外,其他單詞的首字母大寫,如getCurrentPage();
不要採用不常用的縮寫,如where2go();
使用常用的縮寫時,只大寫首字母,如getHtml()。
第2章 版式規則
2.1 語義分隔
各個函式、方法之間應該採用空行間隔;
同一個函式中聯絡緊密的語句之間可以不換行,其他情況需要換行。
2.2 空格規則
2.2.1 邏輯運算子前後必須加空格
正確
複製程式碼 程式碼如下:
$a == $b;
錯誤
複製程式碼 程式碼如下:
$a==$b;
$a ==$b;
正確
複製程式碼 程式碼如下:
$a++; $a--;
錯誤
複製程式碼 程式碼如下:
$a ++; $a --;
備註 加一減一運算子不能加空格。
2.2.2 多個引數分隔時必須加空格
正確
複製程式碼 程式碼如下:
$g_pro , $g_user , g_show;
get_db_info($host, $user, $passwd);
錯誤
複製程式碼 程式碼如下:
$g_pro,$g_user,$g_show;
get_db_info($host,$user,$passwd);
2.2.3 語法關鍵字後必須加空格
例如:If, for , while, switch …..
正確
複製程式碼 程式碼如下:
for ($i = 0; $i < 10; $i++)
錯誤
複製程式碼 程式碼如下:
for($i = 0; $i < 10; $i++ )
2.3 字串和變數連線規則
字串與變數連線使用'.'號時,必須在'.'前後加空格,使用"號時,必須在變數前後加"{}"。
正確