PHP教程:PHP編碼書寫規范(6)_PHP教程
推薦:PHP中addcslashes函數與stripcslashes的用法今天在寫一個網站的英文版時,寫完后填加英文資料,我隨便填寫時一點問題沒有,但每當填加指定的內容時卻填加不上,也不報錯,我查看了數據庫,發現這個字段用的是“TEXT”數據數型,
8 命名規范
8.1 命名空間
一個唯一命名空間的前綴總是全部小寫的ASCII字母并且是一個頂級域名,通常是com,edu,gov,mil,net,org,或1981年ISO 3166標準所指定的標識國家的英文雙字符代碼。命名空間的后續部分根據不同機構各自內部的命名規范而不盡相同。這類命名規范可能以特定目錄名的組成來區分部門(department),項目(project),機器(machine),或注冊名(login names),也可以按功能模塊來分類。
8.2 類
類名是個一名詞,采用大小寫混合的方式,每個單詞的首字母大寫。盡量使你的類名簡潔而富于描述。使用完整單詞,避免縮寫詞(除非該縮寫詞被更廣泛使用,像URL,HTML)
class Raster; class ImageSprite |
在為類(class)命名前首先要知道類的功能。如果通過類名的提供的線索,不能準確反映類的功能,那么,命名就是失敗的。
超過三個詞組成的混合名是容易造成系統各個實體間的混淆,嘗試使用(CRC Session card)看看該命名所對應的實體是否有著那么多的功用。
對于派生類的命名應該避免帶其父類名的誘惑,一個類的名字只與它自身有關,和它的父類無關。
有時后綴名是有用的,例如:如果你的系統使用了代理(agent),那么就把某個部件命名為“下載代理”(downloadAgent)用以真正的傳送信息。
8.2.1 類屬性的命名
屬性命名應該以字符‘m’為前綴。
前綴‘m’后采用于類命名一致的規則。
‘m’總是在名字的開頭起修飾作用,就像以‘r’開頭表示引用一樣。
理由
前綴'm'防止類屬性和方法名發生任何沖突。你的方法名和屬性名經常會很類似,特別是存取元素。
例如
class NameOneTwo { int $mVarAbc; int $mErrorNumber; String $mrName; } |
8.3 函數
方法名是一個動詞,采用大小寫混合的方式,第一個單詞的首字母小寫,其后單詞的首字母大寫。
function run(); function runFast(); function getBackground(); |
通常每個方法都是執行一個動作的,所以對它的命名應該清楚的說明它是做什么的:用checkForErrors()代替errorCheck(),用dumpDataToFile()代替dataFile()。這么做也可以使功能和數據成為更可區分的物體。
有時后綴名是有用的:
Max - 含義為某實體所能賦予的最大值。
Cnt - 一個運行中的計數變量的當前值。
Key - 鍵值。
例如:retryMax 表示最多重試次數,retryCnt 表示當前重試次數。
有時前綴名是有用的:
is - 含義為問一個關于某樣事物的問題。無論何時,當人們看到Is就會知道這是一個問題。
get - 含義為取得一個數值。
set - 含義為設定一個數值
例如:isHitRetryLimit
8.4 變量
除了變量名外,所有實例,包括類,類常量,均采用大小寫混合的方式,第一個單詞的首字母小寫,其后單詞的首字母大寫。變量名不應以下劃線或美元符號開頭,盡管這在語法上是允許的。
變量名應簡短且富于描述。變量名的選用應該易于記憶,即,能夠指出其用途。盡量避免單個字符的變量名,除非是一次性的臨時變量。臨時變量通常被取名為i,j,k,m和n,它們一般用于整型;c,d,e,它們一般用于字符型。
char $c; int $i; float $myWidth; |
8.5 實例變量
大小寫規則和變量名相似,除了前面需要一個下劃線
int $_employeeId; String $_name; Customer $_customer; |
8.6 常量
類常量和ANSI常量的聲明,應該全部大寫,單詞間用下劃線隔開。(盡量避免ANSI常量,容易引起錯誤)
static final int $MIN_WIDTH = 4; static final int $MAX_WIDTH = 999; static final int $GET_THE_CPU = 1; |
分享:PHP.MVC的模板標簽系統PHP.MVC的模板標簽系統(PhpMVC_Tags)現在提供了3種類型的標簽:包含指令,聲明和表達式. 包含指令能讓我們將內容分隔為許多模塊,比如:頁眉,頁腳或者內容.包含的頁面可以是HTML,或者其他標簽模板頁
- 相關鏈接:
- 教程說明:
PHP教程-PHP教程:PHP編碼書寫規范(6)。