培養自己的php編碼規范

2020-03-22 17:40:26

字體：大中小

來源：轉載

供稿：網友

為什么我們要培養自己的編碼規范？我們寫代碼的時候，一個好的編碼規范，對我們來說能夠起到很多意向不到的效果。至少會有一下的好處：
1、提高我們的編碼效率。整齊劃一的代碼方便我們進行復制粘貼嘛！
2、提高代碼的可讀性。
3、顯示我們專業。別人看到了我們的代碼，發現整個代碼的書寫流程都整齊劃一，瞬間逼格就上去了！
4、方便團隊協同工作。大家使用同一的規范，這樣就消除了五花八分的書寫方式，同一協調！編碼規范包含兩大塊，代碼規范和注釋規范其實我們所寫的php腳本，其實也就是由兩大塊組成的，即對代碼的書寫、對代碼的注釋！不同的框架，甚至不同的公司，對這方面都會有所不同，這里只是已將之言，僅僅是對自己的書寫規范進行一個總結！希望能對其他的朋友以啟示1、代碼的書寫規范文件夾的命名：
文件夾同一使用小寫字母。如存放控制器的文件夾，直接命名為controller即可文件的命名：
如果是類文件的話，那么文件的命名應該同類名稱保持一致，統一使用大駝峰。如Session.html' target='_blank'>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'; 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......; statements......; while($condition)
2、注釋的書寫規范很多人說好的代碼是不需要注釋的，其實，個人認為這是一句很扯淡的話（也可能他是對的，除非整個團隊就他一個人，他包辦了一切，不用看別人的代碼）。個人的觀點是：多寫注釋，無論是對團隊的其他人，還是對自己都是非常友好的！根據個人的經驗來看，注釋至少有以下幾個作用：
1、有利于提高代碼的可讀性，畢竟讀你的注釋要比讀你的代碼要容易的多！
2、有利于規劃自己的代碼布局！之所以這么說，是因為和代碼注釋的種類有關?！坝欣诖a的布局”，這種看著有點懸的事，光說是說不明白的，我們需要實實在在的例子做支撐！
3、由于我們的注釋規范是按照phpdocumentor的要求，所以通過這個工具，還可以生成一份對代碼的總體說明，相當于一個使用說明書！g代碼注釋的種類
1、塊注釋
塊注釋，個人認為主要用在了三個地方。對php腳本的描述、對一個大的功能模塊的描述、在一行之內不能寫完注釋的時候，也應該放在塊注釋中2、行注釋
行注釋，個人認為他是配合塊注釋進行工作的！一般用于描述一個大的功能模塊的具體細節！實戰的案例
關于phpdocumentor語法的具體使用細節，這里就不多說了，網址上說的再清楚不過了從上面的例子中我們可以看一下代碼的布局大致是怎么回事，但是還需要我們在實踐中慢慢摸索下面附上一些php的編程規范，給大家參考下一、文件標記：1.所有php文件，其代碼標記均采用完整php標簽，不建議使用短標簽（短標簽容易和xml混淆，php從5.4開始默認不支持短標記）。2.對于只有php的代碼文件，建議省略結尾處的‘ '。這是為了防止多余的空格或其他字符影響到代碼。二、文件和目錄命名1.程序文件名和目錄名均采用有意義的英文命名，不使用拼音和無意義的字母，只允許出現字母、數字、下劃線和中劃線字符，同時必須以‘.php'結尾（模板文件除外），多個詞間使用駝峰命名法。例：//類統一采用：DemoTest.class.php //接口統一采用：DemoTest.interface.php //其他按照各自的方式：demoTest.{style}.php三、文件目錄結構規范的目錄結構有助于團隊協作開發和后期維護?！猘pp //獨立的應用——class //單個的類文件，共用的類文件——conf/inc //配置文件或目錄——data //數據文件或目錄——doc //程序相關文檔——htdocs //document_root——images //所有圖片文件存放路徑——css //css文件——js //js文件——lib //共用類庫——template //模板文件——tmp //臨時文件目錄——cache //緩存文件——session //SESSION文件——template_c //編譯后的模板文件——other——upload //上傳文件——manage //后臺管理文件目錄四、命名規范1.變量命名：php中變量區分大小寫，一個有效的變量名由數字、字母或下劃線開頭，后面跟任意數量的字母、數字、下劃線。 a）程序整體以駝峰命名法，以小寫字母開始，同時命名要有意義。（function displayName()） b）PHP全局變量鍵值兩邊都有‘_'，中間用駝峰命名法命名。（$_GLOBAL['_beginTime_']） c）普通變量整體采用駝峰命名法，建議在變量前加表示類型的前綴。不確定類型的以大寫字符開頭。 d）函數名要盡量有意義，盡量縮寫。2.類及接口命名： a）以大寫字母開頭。 b）多個單詞組成的變量名，單詞之間不用間隔，各個單詞首字母大寫。 c）類名與類文件名保持一致。 d）程序中所有的類名唯一。 e）抽象類應以Abstract開頭。接口命名規則： i）采用和類相同的命名規則，但在其命名前加‘i'字符，表示接口。 ii）盡量保持和實現它的類名一致。3.數據庫命名：在數據庫相關命名中，一律不出現大寫。 a）表名均使用小寫字母。 b）表名使用同一的前綴且前綴不能為空。 c）對于多個單詞組成的表名，使用‘_'間隔。 d）表字段命名規則。 i）全部使用小寫字母。 ii）多個單詞不用下劃線分割。 iii）給常用字段加上表名首字母做前綴。 iv）避免使用關鍵字和保留字。五、注釋規范1.程序注釋：寫在代碼前面而不是后面，單行代碼按照習慣寫在代碼尾部；大段注釋采用/**/的方式，通常為文件或函數的頂部，代碼內部使用'//'；注釋不宜太多；代碼注釋應該描述為什么而不是做什么，給代碼閱讀者提供最主要的信息。2.文件注釋：文件注釋一般放在文件的頂部，包括本程序的描述、作者、項目名稱、文件名稱、時間日期、版本信息、重要的使用說明（類的調用，注意事項等）。版本更改要修改版本號，并加上mofify注釋。3.類和接口注釋：按照一般的習慣，一個文件只包含一個類。4.方法和函數注釋：方法和函數的注釋寫在前面，通常需要表明信息的主要可見性、參數類型和返回值類型。 /** * 連接數據庫 * @param string $dbhost 數據庫服務器地址 * @param string $dbuser 數據庫用戶名 * @param string $dbpwd 數據庫密碼 */六、代碼風格1.縮進和空格：使用4個空格做為縮進，不使用Tab鍵；變量賦值時，等號兩邊留出空格。（$url = '$_GET['url']';）2.語句斷行：盡量保證程序語句一行即一句；盡量不要使一行的代碼過長，80個字符以內；如果一行的代碼太長，請使用類似于‘.='方式斷行連接；執行數據庫的sql語句操作時，盡量不要再函數內寫sql語句，而先用變量定義sql語句，然后在執行操作的函數中調用定義的變量。3.更好的習慣：在代碼中使用下面列舉的方法，可以使代碼更優雅。 1）：多使用php中已經存在的常量，而不要自己定義。例：//換行 echo $msg."/r/n"; echo $msg,PHP_EOL; php中PHP_EOL是一個預定義常量，表示一行結束，隨著所使用系統不同，使用PHP_EOL代碼可移植性更高 2）：在echo中使用逗號做連接符，比用‘.'做連接符代碼更美觀。 3）：單引號的效率高于雙引號，但二者在使用上有區別，學會使用printf函數。例：//echo echo '每個'.$scholl.'大約有'.floor($avg).'個學生'； //printf $format = '每個%s大于有$d個學生'; printf($format,$school,$avg); 4) ：詳細的注釋 5）：不要濫用語法糖，語法糖就是語言中的潛規則，即不具備普遍代表性的語法。PHP教程

鄭重聲明：本文版權歸原作者所有，轉載文章僅為傳播更多信息之目的，如作者信息標記有誤，請第一時間聯系我們修改或刪除，多謝。

上一篇：php為什么需要異步編程？php異步編程的詳解（附示例）

下一篇：PHP實現AOP的基礎