最近又在推動公司內(nèi)部PHPer們代碼規(guī)范化，今天我整理了一下貼出來以供大家參考。

<?php //開頭// 不結(jié)尾 PHP代碼文件必須以不帶BOM的UTF-8編碼。

例sublime, setting增加，'show_encoding' : true 每行的字符數(shù)不超過 80 個字符

例，sublime'word_wrap': 'true','wrap_width': 80, tap鍵4個空格

例，sublime'tab_size': 4, PHP代碼中應(yīng)該只定義類(trait)/函數(shù)/常量/其他會產(chǎn)生副作用的操作（如：生成文件輸出以及修改 .ini 配置文件等），只能選其一。

例，a.phpclass A{}b.phpfunction demo(){}c.phpdefine(’A’, value);d.phpini_set(’some_vars’, value); 類/trait/Interface的命名必須遵循 StudlyCaps 大寫開頭的駝峰命名規(guī)范。

class StudlyCaps{}trait StudlyCaps{}Interface StudlyCaps{} 類中的常量所有字母都必須大寫，單詞間用下劃線分隔。

define(’FOO_BAR’, ’something more’);const FOO_BAR = value; 方法(類/trait中)名稱必須符合 camelCase 式的小寫開頭駝峰命名規(guī)范。

class StudlyCaps{ public function studlyCaps() {// coding... }} 函數(shù)名稱必須符合 snake_case 式的下劃線式命名規(guī)范。

function snake_case(){ // coding...} 私有的(private)方法(類/trait中)名稱必須符合 _camelCase 式的前置下劃線小寫開頭駝峰命名規(guī)范。

class StudlyCaps{ private function _studlyCaps() {// coding... }} 方法名稱 第一個單詞 為動詞。

class StudlyCaps{ public function doSomething() {// coding... }} 變量 必須符合 camelCase 式的小寫開頭駝峰命名規(guī)范。

class StudlyCaps{ public function doSomething() {$someVariable = ’demo’;// coding... }} 方法/函數(shù) 多參數(shù)時，之間要有1個空格

class StudlyCaps{ public function doSomething($variableOne, $variableTwo) {// coding... }} 運算符/表達(dá)式 要有一個空格

$a = $b + $c;$a = $b . $c; 每個 namespace 命名空間聲明語句塊 和 use 聲明語句塊后面，必須 插入一個空白行。

namespace Standard;// 空一行use TestTestClass;//use引入類// 空一行 類的開始花括號 “{ “必須 寫在函數(shù)聲明后自成一行，結(jié)束花括號”}”也必須寫在函數(shù)主體后自成一行。

class StudlyCaps{} 方法/函數(shù)的開始花括號 { 必須 寫在函數(shù)聲明后自成一行，結(jié)束花括號 }也 必須 寫在函數(shù)主體后自成一行。

class StudlyCaps{ public function studlyCaps() {// coding... }}function snake_case(){ // coding...} 類的屬性和方法 必須 添加訪問修飾符（private、protected 以及 public），abstract 以及 final 必須 聲明在訪問修飾符之前，而 static 必須 聲明在訪問修飾符之后。

abstract class StudlyCaps{abstract public function studlyCaps();final public static function studlyCapsOne(){}} 控制結(jié)構(gòu)的關(guān)鍵字后 必須 要有一個空格符，而調(diào)用方法或函數(shù)時則 一定不可 有。

if ($valueOne === $valueTwo) { // code...}switch ($valueThree) { case ’value’: // code... break; default: // code... break;}do { // code...} while ($valueFour <= 10);while ($valueFive <= 10) { // code...}for ($i = 0; $i < $valueSix; $i++) { // code...}$demo = new Demo()$demo->doSomething();do_something(); 控制結(jié)構(gòu)的開始花括號 { 必須 寫在聲明的同一行，而結(jié)束花括號 } 必須 寫在主體后自成一行。

if ($valueOne === $valueTwo) { // code...}switch ($valueThree) { case ’value’: // code... break; default: // code... break;}do { // code...} while ($valueFour <= 10);while ($valueFive <= 10) { // code...}for ($i = 0; $i < $valueSix; $i++) { // code...} 控制結(jié)構(gòu)的開始左括號后和結(jié)束右括號前，都一定不可有空格符。

if ($valueOne === $valueTwo) {// 控制結(jié)構(gòu)（右邊和)左邊不加空格 // code...} 編碼建議 sql過長

// heredoc語法$sql = <<<SQLSELECT delivery_idFROM d_testWHERE delivery_idIN (123,234)GROUP BY delivery_idHAVING SUM(send_number) <= 0;SQL; if等控制結(jié)構(gòu)條件過長

if ($a > 0 && $b > 0 && $c > 0 && $d > 0 && $e > 0) {} 方法或函數(shù)參數(shù)大于三個換行

public function tooLangFunction( $valueOne = ’’, $valueTwo = ’’, $valueThree = ’’, $valueFour = ’’, $valueFive = ’’, $valueSix = ’’){ //coding...} 鏈?zhǔn)讲僮鞒^兩個

$this->nameTest->functionOne() ->functionTwo() ->functionThree(); 數(shù)組php5.4以后，使用[]

$a = [ ’aaa’ => ’aaa’, ’bbb’ => ’bbb’]; 單引號多引號 字符串中無變量，單引號 字符串中有變量，雙引號

$str = ’str’;$arg = '$str'; 聲明類或者方法或函數(shù)添加描述&屬性描述&作者

/** * 類描述 * * desc */class StandardExample{ /** * 常量描述. * * @var string */ const THIS_IS_A_CONST = ’’; /** * 屬性描述. * * @var string */ public $nameTest = ’’; /** * 構(gòu)造函數(shù). * * 構(gòu)造函數(shù)描述 * @author name <email> * @param string $value 形參名稱/描述 * @return 返回值類型返回值描述 * 返回值類型：string，array，object，mixed（多種，不確定的），void（無返回值） */ public function __construct($value = ’’) { // coding... } api方法提供測試樣例example

/** * 成員方法名稱. * * 成員方法描述 * * @param string $value 形參名稱/描述 * * @example domain/api/controller/action?argu1=111&argu2=222 */public function testFunction($value = ’’){ // code...} 使用try…catch…

try { // coding...} catch (Exception $e) { // coding...} 連續(xù)調(diào)用多個方法(大于3個)使用foreach

// 改寫doSome為doSomethingclass StandardExample{ /** * 方法列表 * * @var array */ private $_functionList = []; public function __construct($functionList = array()) { $this->_functionList = $value; } public function doSome() { $this->functionOne(); $this->functionTwo(); $this->functionThree(); $this->functionFour(); } public function doSomething() { foreach($this->_functionList as $function) { $this->$function(); } } ...} 文件頂部進(jìn)行版權(quán)聲明

// +----------------------------------------------------------------------// | Company Name xx服務(wù)// +----------------------------------------------------------------------// | Copyright (c) 2017 http://domain All rights reserved.// +----------------------------------------------------------------------// | Author: name <email>// +----------------------------------------------------------------------

來自：http://tigerb.cn/2017/03/06/standard/