我的php編碼規範

為什麼我們要培養自己的編碼規範？

我們寫代碼的時候，一個好的編碼規範，對我們來說能夠起到很多意向不到的效果。至少會有一下的好處：
1、提高我們的編碼效率。整齊劃一的代碼方便我們進行複製粘貼嘛！
2、提高代碼的可讀性。
3、顯示我們專業。別人看到了我們的代碼，發現整個代碼的書寫流程都整齊劃一，瞬間逼格就上去了！
4、方便團隊協同工作。大家使用同一的規範，這樣就消除了五花八分的書寫方式，同一協調！

編碼規範包含兩大塊，代碼規範和注釋規範

其實我們所寫的php指令碼，其實也就是由兩大塊組成的，即對代碼的書寫、對代碼的注釋！不同的架構，甚至不同的公司，對這方面都會有所不同，這裡只是已將之言，僅僅是對自己的書寫規範進行一個總結！希望能對其他的朋友以啟示

1、代碼的書寫規範

檔案夾的命名：
檔案夾同一使用小寫字母。如存放控制器的檔案夾，直接命名為controller即可

檔案的命名：
如果是類檔案的話，那麼檔案的命名應該同類名稱保持一致，統一使用大駝峰。如Session.class.php , 對應類名稱為Session，
如果是普通的工具指令碼，那麼統一使用小駝峰，如common.php

類名稱的命名：
類名稱同一使用大駝峰，Cookie類

方法名的命名：
統一使用小駝峰，一般使用 動詞 + 名次 的形式來描述該方法的功能，如sendMessage,傳送簡訊。
在物件導向中，遵循同樣的規則，但是個別地方有所區別：
public getUserName()
protected _getTotalAmount()
private _setBlanceAmount()

變數的命名規範：
關於變數，我們需要多說幾點：
1、無論在物件導向還是非物件導向的文法中，變數統一使用小駝峰，如：$workYears。
但是在物件導向中又有所不同，public 、 protected 、 private ,protected或者private屬性的時候，前面加上了 _ 作為區別

public $startPosition = 1;protected $_salaryAmount =1000; private $_sex = 'formale';

2、如果是常量的話，統一使用大寫，中間使用底線進行分割。

define('CURRENT_SCRIPT', 'index.php');const TRANSACTION_TYPE = 'income';

3、全域變數，使用大駝峰，首碼加上 _ ,所有的單字首大寫。因為知道一個變數的範圍是非常重要的，所以局部變數和全域變數應該很明顯的進行分開！

$_System_Config;$_Root_Path;

縮排符
關於編碼的縮排符號，我們統一使用定位字元縮排！也許有的人會問為什麼不適用空格縮排的呢？
原因很簡單，大部分的編輯器都支援定位字元等於多少個空格，而使用空格就沒得調了！

運算子號
所有的兩元運算子號，都應該前後使用空格進行
$name = 'zero';
$age > 18 ? 'adult' : 'children';

常見的流程語句規劃
我們約定，所有的流程語句的花括弧都單獨佔據一行。理由：如果遇到較為複雜的商務邏輯，花括弧會出現很多的嵌套，這樣一來我們會混淆個個對應的花括弧！
1、分支語句

if($age >= 18 && $age <= 30) {    echo 'young man';}else if($age > 30 && $age <= 60){    echo 'middle aged';}else{    echo 'old man';}//下面這段代碼高手我們一個問題，在if語句中，即使在可以不要花括弧的情況下，花括弧也是要寫上的if($age > 60){    echo 'I am very old';}

switch($status){    case 'forbiden'：        echo 'login forbidden';        break;           case 'normal':        echo 'login in';        break;            default:        echo 'status is wrong' ：        break;}

2、迴圈語句

while($condition){    statesments......;}

foreach($arrayList as $arrayKey => $arrayItem){    states......;}

do{    statements......;    }while($condition)

for($start; condition; changenumber){    statements......;}

2、注釋的書寫規範

很多人說好的代碼是不需要注釋的，其實，個人認為這是一句很扯淡的話（也可能他是對的，除非整個團隊就他一個人，他包辦了一切，不用看別人的代碼）。

個人的觀點是：多寫注釋，無論是對團隊的其他人，還是對自己都是非常友好的！

根據個人的經驗來看，注釋至少有以下幾個作用：
1、有利於提高代碼的可讀性，畢竟讀你的注釋要比讀你的代碼要容易的多！
2、有利於規劃自己的代碼布局！之所以這麼說，是因為和代碼注釋的種類有關。“有利於代碼的布局”，這種看著有點懸的事，光說是說不明白的，我們需要實實在在的例子做支撐！
3、由於我們的注釋規範是按照phpdocumentor的要求，所以通過這個工具，還可以產生一份對代碼的總體說明，相當於一個使用說明書！g

代碼注釋的種類
1、塊注釋
塊注釋，個人認為主要用在了三個地方。對php指令碼的描述、對一個大的功能模組的描述、在一行之內不能寫完注釋的時候，也應該放在塊注釋中

2、行注釋
行注釋，個人認為他是配合塊注釋進行工作的！一般用於描述一個大的功能模組的具體細節！

實戰的案例
關於phpdocumentor文法的具體使用細節，這裡就不多說了，官網上說的再清楚不過了

從上面的例子中我們可以看一下代碼的布局大致是怎麼回事，但是還需要我們在實踐中慢慢摸索

