PHP編碼規(guī)范24條

2013-06-03 09:29:48來源:Linux Today作者:

一、文件格式

一、文件格式

1. 對于只含有 PHP 代碼的文件,我們將在文件結(jié)尾處忽略掉 ”?>” 。這是為了防止多余的空格或者其它字符影響到代碼。

例如:

<?php
$foo = ’foo’;
2. 縮進應(yīng)該能夠反映出代碼的邏輯結(jié)果,盡量使用四個空格,禁止使用制表符TAB,因為這樣能夠保證有跨客戶端編程器軟件的靈活性。

例如:

if (1 == $x) {
$indented_code = 1;
if (1 == $new_line) {
$more_indented_code = 1;
}
}
3. 變量賦值必須保持相等間距和排列。

例如:

$variable = ’demo’;
$var      = ’demo2′;

4. 每行代碼長度應(yīng)控制在80個字符以內(nèi),最長不超過120個字符。因為 Linux 讀入文件一般以80列為單位,就是說如果一行代碼超過80個字符,那么系統(tǒng)將為此付出額外操作指令。這個雖然看起來是小問題,但是對于追求完美的程序員來說也是值得注意并遵守的規(guī)范。

5. 每行結(jié)尾不允許有多余的空格。

二、命名約定

1. 類文件都是以“.class.php“為后綴,且類文件名只允許字母,使用駝峰法命名,并且首字母大寫,例如:DbMysql.class.php 。

2. 配置和函數(shù)等其他類庫文件之外的文件一般是分別以“.inc.php“和”.php“為后綴,且文件名命名使用小寫字母和下劃線的方式,多個單詞之間以下 劃線分隔,例如config.inc.php , common.php,install_function.php 。

3. 確保文件的命名和調(diào)用大小寫一致,是由于在類Unix系統(tǒng)上面,對大小寫是敏感的。

4. 類名和文件名一致(包括上面說的大小寫一致),且類名只允許字母,例如 UserAction類的文件命名是UserAction.class.php, InfoModel類的文件名是InfoModel.class.php 。

5. 控制器類以Action為后綴,例如 UserAction、InfoAction ,模型類以Model為后綴,例如UserModel、InfoModel ,其他類也分別以相應(yīng)分類為后綴,例如Service 、Widget。

6. 方法名只允許由字母組成,下劃線是不允許的,首字母要小寫,其后每個單詞首字母要大寫,即所謂的 “駝峰法命名” 規(guī)則,且越詳細越好,應(yīng)該能夠描述清楚該方法的功能,例如switchModel、findPage。

7. 屬性的命名只允許由字母組成,下劃線是不允許的,首字母要小寫,其后每個單詞首字母要大寫,即所謂的 “駝峰法命名” 規(guī)則,例如tablePrefix、tableName 。

8. 對于對象成員的訪問,我們必須始終使用 “get” 和 “set” 方法。例如:

class Foo
{
protected $_testObj;
public function getTestObj()

{
return $this->_testObj;
}
public function setTestObj($testObj)

{
$this->testObj = $_testObj;
}
}
9. 當(dāng)類成員方法被聲明為 private 時,必須分別以雙下劃線 ”__”為開頭;被聲明為 protected 時,必須分別以單下劃線 ”_” 為開頭;一般情況下的方法不含下劃線。例如 :

class Foo
{
private function __example()

{
// …
}
protected function _example()

{
// …
}
public function example()

{
// …
}
}
10. 如果我們需要把一些經(jīng)常使用的方法定義為全局函數(shù),那么應(yīng)該把它們以靜態(tài) (static) 的形式定義在類中。例如:

class Think
{
// …
static public function autoload($classname)

{
// …
}
}
11. 被聲明為 private的類成員屬性必須由雙下劃線 ”__” 作為開頭;被聲明為 protected 的類成員屬性必須由下劃線 ”_” 作為開頭;而聲明為 public 的成員屬性則在任何時候都不允許含有下劃線。

12. 函數(shù)的命名使用小寫字母和下劃線的方式,且越詳細越好,應(yīng)該能夠描述清楚該函數(shù)的功能,例如 get_client_ip 。

13. 當(dāng)方法或函數(shù)參數(shù)不一定需要被賦值的時候,用 ”null” 來代替 ”false” 作為函數(shù)參數(shù)的默認值,除非該參數(shù)是 boolean 值。

14. 變量只允許由小寫字母和下劃線組成,且建議用描述性的變量的命名,越詳細越好,以至于像 $i 或 $n 等等都是不鼓勵使用的。

15. 類中的常量 constant 和全局范圍內(nèi)常量define,只能由大寫字母和下劃線組成,各個單詞之間以下劃線分割。

16. boolean 值和 null 值都采用小寫。

三、編碼風(fēng)格

1. php 代碼必須以完整的形式來定界(<?php … ?>),即不要使用php 短標(biāo)簽(<? … ?>),且保證在關(guān)閉標(biāo)簽后不要有任何空格。

2. 當(dāng)一個字符串是純文本組成的時候(即不含有變量),則必須總是以單引號(’)作為定界符。例如:

$a = ’Example String’;
3. 變量替換中的變量只允許用 $+變量名 的形式。例如:

$greeting = ”Hello $name, welcome back!”;   // 允許
$greeting = ”Hello {$name}, welcome back!”; // 允許
$greeting = ”Hello ${name}, welcome back!”; // 不允許
當(dāng)用點號 ”.” 連接各字符串的時候,字符串與點號間必須用一個空格隔開,且允許把它分割成多行以增強可讀性。在這種情況下,點號 ”.” 必須與等于號 ”=” 對齊。例如:

$sql = ”SELECT `id`, `name` ” . ” FROM `people` ”
. ”WHERE `name` = ’Susan’ ”
. ”ORDER BY `name` ASC ”;
當(dāng)用 array 類型符號來構(gòu)造數(shù)組的時候,必須在每個逗號之后加上一個空格來增強可讀性。例如:$sampleArray = array(1, 2, 3, ’Think’, ’SNS’);

4. 當(dāng)使用 array 類型符聲明關(guān)聯(lián)數(shù)組的時候,我們鼓勵把它分成多個行,只是我們必須同時保證每行的鍵與值的對齊,以保持美觀。例如:

$sampleArray = array(
‘firstKey’  => ’firstValue’,
’secondKey’ => ’secondValue’
);
5. 大括號的開始必須在類名的下一行頂格。例如:

class Think
{
// …
}
6. 類中的所有代碼都必須用四個空格來進行縮進。

7. 每個 php 文件只允許聲明一個類。在類文件里面寫其它代碼是允許的,但并不鼓勵這樣做。假如真要附加代碼的話,必須用空行來分隔。

8. 任何類變量的聲明都必須放在類頂部,先于任何函數(shù)的聲明。

9. 不允許用 var 符號來聲明變量,類成員變量必須以 private,protected 和 public 來聲明。其次,把類成員聲明為 public 而直接引用雖然是允許的,但通常更好的方法是使用 get 和 set 方法來訪問類成員。

10. 方法必須總是用 private,protected 或者 public 來聲明其作用域。

11. 靜態(tài) static 方法應(yīng)該聲明其作用域,且不應(yīng)該再被聲明為 private 私有,而應(yīng)該為 protected 或者public ,如果只是不想被子類繼承,則應(yīng)該用 final 聲明它們。

12. 函數(shù)或方法的初始大括號應(yīng)該在函數(shù)聲明的下一行頂格。例如:

function get_client_ip()
{
// …
}
13. 在函數(shù)或方法名與參數(shù)括號之間不允許出現(xiàn)多余的空格。例如:

function get_client_ip()
{
// …
}
14. 引用只允許定義在函數(shù)參數(shù)中,實時傳遞引用是禁止的。例如:

// 引用定義在函數(shù)參數(shù)-允許的
function defineRefInMethod(&$a)
{
$a = ’a';
}
defineRefInMethod($b);
echo $b; // ’a’
// 實時傳遞引用-禁止的
function callTimePassRef($a)
{
$a = ’a';
}
callTimePassRef(&$c);
echo $c; // ’a’
15. 函數(shù)或方法返回值不可以用括號包住,不然會降低可讀性,而且假如以后函數(shù)修改為返回引用的話,這將會拋出一個異常。

16. 鼓勵盡量使用類型提示,特別是在模塊設(shè)計中。例如:

class Foo
{
public function foo(SomeInterface $object)

{
}
public function bar(array $options)

{
}
}
17. 函數(shù)和方法參數(shù)必須用逗號+空格來分隔。

18. 對于參數(shù)為數(shù)組的函數(shù),參數(shù)中的數(shù)組應(yīng)該分成多行以增強可讀性。例如:

threeArguments(array(1, 2, 3), 2, 3);
threeArguments(array(1, 2, 3, ’Think’,
‘SNS’, $a, $b, $c,
56.44, $d, 500), 2, 3);
19.  基于”if”, ”else”和”else if”的條件控制里,我們必須用空格間隔開語句和括號,大括號的開始 ”{“ 必須與條件控制語句位于同一行,結(jié)束 ”}” 必須總是獨占一行且頂格,控制流程內(nèi)容必須用四個空格進行縮進,且不使用”elseif”。

if ($condition) {
// …
} else if ($_condition) {
// …
} else {
// …
}
20. 在條件控制語句的條件括號內(nèi),必須用空格將操作符與其它元素隔開。如果遇到很長的邏輯判斷,則鼓勵用內(nèi)嵌括號來分割各個邏輯。例如:

if (($a != 2) and ($b == 1)) {
$a = $b;
}
21. “switch” 條件控制語句中,必須用空格將待測參數(shù)與其它元素分隔開。例如:

switch ($num) {
// …
}
22.  ”switch” 語句的內(nèi)容必須以四個空格縮進,”case” 條件控制的內(nèi)容必須再加四個空格進行縮進。例如:

switch ($indentedSpaces) {
case 2:
echo ”錯誤”;
break;
case 4:
echo ”正確”;
break;
default:
break;
}
23. 在 ”switch” 語句中應(yīng)該總是包括 ”default” 控制。

24. 有時候我們需要在 ”case” 語境中省略掉 ”break” 或 ”return” ,這個時候我們必須為這些 ”case” 語句加上 ”// 此處無break” 注釋。例如:

switch ($numPeople) {
case 1: // 此處無break

case 2:
break;
default:
break;
}

 

關(guān)鍵詞:PHP編碼規(guī)范

贊助商鏈接: