PHP編程風格規范分享

相關推薦

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_name.func.php命名。

　　1.3 類

　　類使用英文的大小寫來分隔單詞，包括首個單詞，所有單詞的首字母大寫，如PageManager；

　　在類中，方法放到屬性定義前邊、公用方法放到專用方法前邊；

　　一般情況下，一個類對應到一個文件；

　　當一些類關系緊密時，可以存放在一個文件中；

　　存放類的文件采用ClassName.class.php方式命名。

　　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 字符串和變量連接規則

　　字符串與變量連接使用'.'號時，必須在'.'前后加空格，使用"號時，必須在變量前后加"{}"。

　　正確

　　復制代碼代碼如下:

　　$my_name = 'file_' . $var1;

　　$my_name = "file_{$var1}";

　　錯誤

　　復制代碼代碼如下:

　　$my_name = "file_'.$var1;

　　$my_name = "file_$var1";

　　2.4 圓括號規則

　　函數名后括號不需要加空格、語法關鍵字后的括號必須加空格。

　　正確

　　復制代碼代碼如下:

　　for ($i = 0; $i < 10; $i++)

　　strlen($my_name);

　　錯誤

　　復制代碼代碼如下:

　　for($i = 0; $i < 10; $i++ )

　　strlen ($my_name);

　　2.5 花括號規則

　　花括號必須為上下對應。

　　正確

　　復制代碼代碼如下:

　　if ($a)

　　{

　　$b = $a;

　　}

　　錯誤

　　復制代碼代碼如下:

　　if ($a){

　　$b = $a;

　　}

　　2.6 數組定義規則

　　數組定義和使用時中key值前后必須加單引號。

　　PHP 代碼:

　　正確

　　復制代碼代碼如下:

　　array( 'name' => '', 'gender' => '' );

　　$user_info['name'];

　　錯誤

　　復制代碼代碼如下:

　　array( name => '', gender => '' );

　　$user_info[name];

　　2.7 SQL規則

　　在PHP中嵌入的SQL語句關鍵字全部采用大寫；

　　表名和字段名要用反引號(`)引起來以防止因為字段名中包含空格而出現錯誤；

　　數據值兩邊用單引號''包括，并且應確保數據值中的單引號已經轉義以防止SQL注入。

　　正確

　　復制代碼代碼如下:

　　$sql = "SELECT `user`.`name` FROM `user` WHERE `id` = '$id' LIMIT 1";

　　錯誤

　　復制代碼代碼如下:

　　$sql = "select name.user from name where id = $id ";

　　第3章注釋規則

【PHP編程風格規范分享】相關文章：

Java編程風格與命名規范08-07

PHP符合PSR編程規范的實例07-31

PHP編程與應用06-06

php語言編程07-06