PHP編碼，vim php psr,PHP編碼規范(PSR-1)-基本代碼規范

PSR-1 基本代碼規范

1. 概況

代碼文件必須以<?php或 <?= 標簽開始

PHP編碼、代碼文件必須以不帶BOM頭的 UTF-8 編碼

代碼文件中應該只定義類(class)、函數(function)、常量(constants)等聲明,或其他會產生從屬效應 的操作(如:生成文件輸出以及修改.ini配置文件等),二者只能選其一,也就是說功能唯一;

命名空間以及類必須符合 PSR 的自動加載規范：PSR-4;

類的命名必須遵循StudlyCaps大寫開頭的駝峰命名規范;

vim encoding、類中的常量所有字母都必須大寫，單詞間用下劃線分隔;

方法名稱必須符合camelCase式的小寫開頭駝峰命名規范;

2. 文件

2.1 PHP 標簽

vim格式。PHP代碼必須使用 <?php ?> 長標簽 或 = ?> 短輸出標簽;一定不可使用其它自定義標簽。

2.2 字符編碼

PHP代碼必須且只可使用不帶BOM的UTF-8編碼。

2.3 從屬效應(副作用)

phphtmlurl編碼？一份PHP文件中應該要不就只定義新的聲明，如類、函數或常量等不產生從屬效應的操作，要不就只有會產生從屬效應的邏輯操作，但不該同時具有兩者。 "從屬效應"(side effects)一詞的意思是，僅僅通過包含文件，不直接聲明類，函數和常量等，而執行的邏輯操作。 "從屬效應"包含卻不僅限于:生成輸出,直接的 require 或 include,連接外部服務,修改 ini 配置、拋出錯誤或異常、修改全局或靜態變量、讀或寫文件等。 以下是一個錯誤的例子，一份包含聲明以及產生從屬效應的代碼:

// 從屬效應：修改 ini 配置

ini_set('error_reporting', E_ALL);

// 從屬效應：引入文件

php編碼轉換函數，include "file.php";

// 從屬效應：生成輸出

echo "\n";

// 聲明函數

php rsa，function foo()

{

// 函數主體部分

}

vim語法高亮、下面是一個范例，一份只包含聲明不產生從屬效應的代碼：

// declaration

function foo()

{

php psr？// function body

}

// conditional declaration is *not* a side effect

if (! function_exists('bar')) {

php implode，function bar()

{

// function body

}

}

3. 命名空間和類

命名空間以及類的命名必須遵循 PSR-4。 根據規范，每個類都獨立為一個文件，且命名空間至少有一個層次：頂級的組織名稱(vendor name)。 類的命名必須 遵循 StudlyCaps 大寫開頭的駝峰命名規范。 PHP 5.3及以后版本的代碼必須使用正式的命名空間。 例如:

// PHP 5.3 and later:

namespace Vendor\Model;

class Foo

{

}

5.2.x及之前的版本應該使用偽命名空間的寫法，約定俗成使用頂級的組織名稱(vendor name)如 Vendor_ 為類前綴。

// PHP 5.2.x and earlier:

class Vendor_Model_Foo

{

}

4. 類的常量、屬性和方法

此處的“類”指代所有的類、接口以及可復用代碼塊(traits)

4.1 常量

類的常量中所有字母都必須大寫，詞間以下劃線分隔。 參照以下代碼：

namespace Vendor\Model;

class Foo

{

const VERSION = '1.0';

const DATE_APPROVED = '2012-06-01';

}

4.2 屬性

類的屬性命名可以遵循 大寫開頭的駝峰式 ($StudlyCaps)、小寫開頭的駝峰式 ($camelCase) 又或者是 下劃線分隔式 ($under_score)，本規范不做強制要求，但無論遵循哪種命名方式，都應該在一定的范圍內保持一致。這個范圍可以是整個團隊、整個包、整個類或整個方法。

4.3 方法

方法名稱必須符合 camelCase() 式的小寫開頭駝峰命名規范。

參考文檔