網(wǎng)站建設中的PHP編碼規范
嚴謹的代碼編寫(xiě)習慣將讓用戶(hù)受益終生,下面就PHP開(kāi)發(fā)中一些約定俗成的編碼規范進(jìn)行匯總,以方便用戶(hù)學(xué)習。
命名規范
變量
?全局變量使用$g-開(kāi)頭,如$g-data-list。
?一般的變量使用小寫(xiě)字母命名,單詞之間使用下劃線(xiàn)分隔。
?變量名字應該使用名詞或者形容詞+名詞的方式。如$value,$new-value。
?不要將在循環(huán)中頻繁使用的臨時(shí)變量等用于其他用途,如$i、$j。
常量常量使用大寫(xiě)字母命名,單詞之間使用下劃線(xiàn)分隔,如DB-HOST。
函數函數采用小寫(xiě)字母命名,單詞之間使用下劃線(xiàn)分隔。函數的命名建議使用動(dòng)詞+名詞的方式,如get-user-img。
類(lèi)類(lèi)使用英文的大小寫(xiě)來(lái)分隔單詞,包括首個(gè)單詞,所有單詞的首字母大寫(xiě),如PageManager。在類(lèi)中,方法放到屬性定義前邊,公用方法放到專(zhuān)用方法前邊;一般情況下,一個(gè)類(lèi)對應到一個(gè)文件;當一些類(lèi)關(guān)系緊密時(shí),可以存放在一個(gè)文件中;存放類(lèi)的文件采用ClassName.class.php方式命名。
方法
方法使用英文的大小寫(xiě)來(lái)分隔單詞,除首個(gè)單詞外,其他單詞的首字母大寫(xiě),如getCurrent-Page();不要采用不常用的縮寫(xiě),如where2go();使用常用的縮寫(xiě)時(shí),只大寫(xiě)首字母,如getHtml()。
版式規范
語(yǔ)義分隔各個(gè)函數、方法之間應該采用空行間隔;同一個(gè)函數中聯(lián)系緊密的語(yǔ)句之間可以不換行,其他情況需要換行。
空格
?邏輯運算符前后必須加空格,例如:$a == $b; //正確$a==$b,$a ==$b; //錯誤$a++; $a–; //正確$a ++; $a –; //錯誤
?加減運算符不能加空格。
?多個(gè)參數分隔時(shí)必須加空格,例如:$g_pro, $g_user, g_show; //正確get_db_info($host, $user, $passwd); //正確$g_pro,$g_user,$g_show; //錯誤get_db_info($host,$user,$passwd); //錯誤
?語(yǔ)法關(guān)鍵字后必須加空格,例如:for($i = 0; $i < 10; $i++) //正確for($i = 0; $i < 10; $i++ ) //錯誤
字符串和變量連接字符串與變量連接使用‘.’號時(shí),必須在‘.’前后加空格,使用“”號時(shí),必須在變量前后加“{}”。
例如:$my_name = ‘file_’ . $var1; //正確$my_name = “file_{$var1}”; //正確$my_name = ‘file_’.$var1; //錯誤$my_name = “file_$var1”; //錯誤
圓括號函數名后括號不需要加空格,語(yǔ)法關(guān)鍵字后的括號必須加空格。例如:for ($i = 0; $i < 10; $i++) //正確strlen($my_name); //正確for($i = 0; $i < 10; $i++ ) //錯誤strlen ($my_name); //錯誤
花括號花括號必須為上下對應。例如,下面寫(xiě)法是正確的。if ($a) { $b = $a;}
數組定義數組定義和使用時(shí)在key值前后必須加單引號。例如:
?正確
array( 'name' => 'd5s.cn', 'gender' => 'php');
?錯誤
array( name => 'd5s.cn', gender => 'php');
SQL字符串
在PHP中嵌入的SQL語(yǔ)句關(guān)鍵字全部采用大寫(xiě);表名和字段名要用反引號(`)引起來(lái)以防止因為字段名中包含空格而出現錯誤;數據值兩邊用單引號'包括,并且應確保數據值中的單引號已經(jīng)轉義,以防止SQL注入。
例如:$sql = “SELECT `user`.`name` FROM `user` WHERE `id` = ‘$id’”; //正確$sql = “select name.user from name where id = $id”; //錯誤
當前文章標題:PHP編碼規范
當前URL:http://amzcoolest.com/news/wzzz/3251.html
上一篇:PHP類(lèi)和對象(2)
下一篇:注釋規范