命名規範
php命名規範
Θ 類文件都以.class.php爲後綴,使用駝峯法命名,並且首字母大寫,例如 Pay.class.php;
Θ 類名和目錄_文件名一致。例如:類名Zend_Autoloader的目錄是Zend/Autoloader.class.php;
Θ 函數的命名使用小寫字母和下劃線的方式。例如:get_client_ip;
Θ 方法的命名使用駝峯法,首字母小寫或者使用下劃線"_",例如listComment(),_getResource(),通常下劃線開頭的方法屬於私有方法;
Θ 屬性的命名使用駝峯法,首字母小寫或者使用下劃線"_",如$username,$_instance,通常下劃線開頭的屬性屬於私有屬性;
Θ 常量以大寫字母和下劃線"_"命名,如"HOME_URL";
常用名詞
1>list名詞(單數),如listApple,一看我們就知道讀取蘋果列表,我們沒有必要寫成getApples或者listApples或readApples——因爲get我們規定一般用於讀取單個數據,如getApple.listApples不加s我們也知道是取蘋果列表(保證儘量縮短變量命名);
2>get名詞(單數);
3>名詞Total,表示某個東西的總數。如expenseTotal;
4>found:表示某個值是否已經找到;
5>uccess或ok:一項操作是否成功;
6>done:某個工程是否完成;
7>error:是否有錯誤發生;
8>result:返回的結果
代碼重構
1.函數或者方法體內的代碼儘量控制在一個屏幕內。
2.類中不使用的方法隨機刪除。
3.修改別人的類中方法,要簽名。
4.在每個模塊內寫個readme文件(用於比較複雜業務的說明或代碼說明)。
5.儘量讓每個類做自己的事,每個函數做一件事。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.