PHP程式碼樣式

如果使用第三方框架，並且有提供程式碼樣式說明，則遵循其程式碼樣式標準，否則如下！

== 格式： 

* 使用UTF-8編碼 

* 使用4個空格縮進，禁止使用Tab 

* Unix樣式換行符（LF） 

* 在分號、冒號和分號運算符空格 

* 在(，[ 後面、]，) 前面不使用空格 

* 在程式碼區塊中使用4個空格縮排 

* 採用層級縮排 

* 在return
* 採用層級縮排 

* 在return的回傳值前使用空行方法的回傳值前使用空白行方法（除非只有一行程式碼）以及在兩個方法中使用空白行區分 

* 在兩個大的邏輯程式碼段之間使用空白行區分 

* 保持行字數在80字以內，最多不超過120 

* 使用標準的PHP標籤定界，禁止使用短標籤（ //... ?>），只包含有PHP代碼的文 
件，禁止使用PHP結束標誌（"?>"），文件結尾使用註解說明"/* End of file */" 

* 單行程式碼也必須使用分號（;）結束 

== 命名： 

* 檔案名稱使用snake_case方式，禁止使用臃腫的檔案名稱 

* 變數名稱使用snake_case方式，禁止使用臃腫的變數名稱 
  * 禁止使用單字元做為局部變數（如$i），在for循環中除外 
  * 禁止使用大寫字母做為全域變數，如使用大寫字母，應使用SCREAMING_SNAKE_CASE方式 

* 類別名稱使用CamelCase方式，方法名稱使用camelCase方式（保持像HTTP，RFC，XML縮寫詞的大寫） 

==

對於嵌入HTML中的PHP程式碼，對於像if, for, foreach, while等程式碼區塊，採用if: ... endif; for: ... endfor; foreach: ... endforeach;以及while: .. . endwhile;方法區塊 

// bad
superclass.php
SuperClass.php
superClass.php
$i = "foobar";  // 单字符变量只充许使用在for循环中
$bufferdText   // 驼峰式变量，并且意思可以再精简些
$groupid        // 两个单词之间需要下划线分开
$name_of_last_city_used // 太长
MyConstant       // 应该用下划线并且字母没有全大写
N                     // 单字符
S_C_VER           // 意思不清楚
class superclass
class superClass
function fileproperties() // 意思不清楚并且没有驼峰式命名
function fileProperties() // 意思不清楚
function getfileproperties() // 好些了，但没有驼峰式命名
// good
super_class.php
for ($i = 0; $i < 10; $i++)
$buffer
$group_id
$last_city
MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
class SuperClass
function getFileProperties()

== 註： 

* 文件區塊必須和phpDocumentor格式相容，請參考： http://phpdoc.org/ 

* 避免多餘的意見 http://phpdoc.org/ 

* 避免多餘的意見