php編碼規範

2021-07-29 02:06:21 字數 1972 閱讀 2384

檔案命名

程式的檔名和目錄名都採用有意義的英文命名。

不使用拼音或無意義的字母。

只允許出現字母、數字、下劃線、中劃線字元。

多個詞之間使用駝峰命名法。

//類統一採用

demotest.class.php

//介面統一採用

demotest.inte***ce.php

普通變數命名

資料型別

命名規範

字串$strmystr

陣列$arrmyarray

物件$objmyobject

布林值$flagmyflag

採用駝峰命名,建議在變數前加上變數的型別作為字首。

變數應該以名詞為準,盡量避免使用常用關鍵字或存在模糊意義的單詞。

私有變數,建議加上字首"_"。

函式命名

函式名即要有意義,也要盡量縮寫,一看就知道幹什麼。

建議單用動詞或動詞加形容詞的格式命名。

私有方法,建議在加上字首"_"。

//例如

private function _showmsg()

習慣與約定

為了減少變數的長度,在不影響可讀性的前提下,習慣對變數進行縮寫。

全稱縮寫

image

imgstring

strdatabase

dbarray

arrcount

cntmessage

msgpassword

passwd 或 pwd

......

檔案注釋

/**

* 檔案的簡述

* * php version 6(php版本)

* * @category  可以寫部門(英文)

* @package   可以寫模組(英文)

* @author    test * @time      2017/02/02 11:48

* @license   公司** license

* @link      [email protected](作者****)

*/

類注釋

/**

* 類的簡述

* * @category 可以寫部門(英文)

* @package  可以寫模組(英文)

* @author   test * @license  公司** license

* @link     [email protected](作者****)

*/

方法注釋

/**

* 方法的簡述

* @param array  $myarray  引數解釋

* @param string $mystring 引數解釋

* @return array(返回資料型別)

*/

**注釋

注釋寫在被注釋**的前面,而不是後面,但對於單行語句,注釋可寫在語句末尾。

對於大段注釋,使用 // 進行注釋。

注釋不宜太多,大家能看的懂得行不必注釋。

**注釋應該描述為什麼,而不是做什麼。

不要為了注釋而注釋。

標註的使用

ide 支援一些特殊注釋,可以列出整個專案中的特殊注釋,方便後期維護和**檢查。

例如://@fixme 表示需要修復項。

//@todo 表示需要完善的地方。

php 編碼規範哪些 php編碼規範

1.php 必須以完整的形式來定界 即不要使用php 短標籤 且保證在關閉標籤後不要有任何空格。2.當乙個字串是純文字組成的時候 即不含有變數 則必須總是以單引號 作為定界符。例如 a example string 3.變數替換中的變數只允許用 變數名 的形式。例如 greeting hello n...

php 編碼規範哪些 PHP編碼規範

很多初學者對編碼規範不以為然,認為對程式開發沒有什麼幫助,甚至因為要遵循規範而影響了學習和開發的進度。或者因為經過一段時間的使用,已經形成了自己的一套風格,所以不願意去改變。這種想法是很危險的。如今的 web 開發,不再是乙個人就可以全部完成的,尤其是一些大型的專案,往往需要十幾人,甚至幾十人來共同...

php 編碼規範哪些 PHP 編碼規範

這是給小組制定的php編碼規範 該 php 編碼規範基本上是同 psr 規範的。有一部分的編碼規範 psr 中是建議,此編碼規範會強制要求。此編碼規範 是以 psr 1 psr 2 psr 2擴充套件 為藍本,並增加了相應的細節說明。通則基本編碼 php 必須使用 長標籤 或 短輸出標籤 一定不可使...