PHP代碼風格指南

PHP 社區百花齊放,擁有大量的函數庫、框架和組件。PHP 開發者一般會在本身的項目中使用若干個外部庫,所以 PHP 代碼遵循(儘量接近)同一個代碼風格就很是重要,這讓開發者能夠輕鬆地將多個代碼庫整合到本身的項目中。php

PHP標準組 提出併發布了一系列的風格建議。其中有部分是關於代碼風格的,即 PSR-0PSR-1PSR-2 和 PSR-4。這些推薦只是一些被其餘項目所遵循的規則,如 Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Lithium 等。你能夠把這些規則用在本身的項目中,或者繼續使用本身的風格。html

一般狀況下,你應該遵循一個已知的標準來編寫 PHP 代碼。多是 PSR 的組合或者是 PEAR 或 Zend 編碼準則中的一個。這表明其餘開發者可以方便的閱讀和使用你的代碼,而且使用這些組件的應用程序能夠和其餘第三方的組件保持一致。git

你可使用 PHP_CodeSniffer 來檢查代碼是否符合這些準則,文本編輯器 Sublime Text 的插件也能夠提供實時檢查。github

你能夠經過如下兩個工具來自動修正你的程序語法,讓它符合標準。 一個是 PHP Coding Standards Fixer,它具備良好的測試。 另一個工具是 php.tools, 它是 sublime text 的一個很是流行的插件sublime-phpfmt,雖然比較新,可是在性能上有了很大的提升,這意味着實時的修復語法會更加的流暢。併發

你也能夠手動運行 phpcs 命令:框架

phpcs -sw --standard=PSR2 file.php

它會顯示出相應的錯誤以及如何修正的方法。一樣地,這條命令也能夠用在 git hook 中,若是你的分支代碼不符合選擇的代碼標準則沒法提交。編輯器

全部的變量名稱以及代碼結構建議用英文編寫。註釋可使用任何語言,只要讓如今以及將來的小夥伴可以容易閱讀理解便可。ide

相關文章
相關標籤/搜索