這是一個之前的一篇文章,感覺很好重新整理又發出來。希望能讓大家有所收獲。
1. 介紹
1.1. 標准化的重要**
標准化問題在某些方面上讓每個人頭痛,讓人人都覺得大家處於同樣的境地。這有助於讓這些建議在許多的項目中不斷演進,許多公司花費了許多星期逐子字逐句的進行爭論。標准化不是特殊的個人風格,它對本地改良是完全開放的。
1.2. 優點
當一個項目嘗試著遵守公用的標准時,會有以下好處:
· 程序員可以了解任何代碼,弄清程序的狀況
· 新人可以很快的適應環境
· 防止新接觸php的人出於節省時間的需要,自創一套風格並養成終生的習慣
· 防止新接觸php的人一次次的犯同樣的錯誤
· 在一致的環境下,人們可以減少犯錯的機會
· 程序員們有了一致的敵人
1.3. 缺點
· 因為標准由一些不懂得php的人所制定,所以標准通常看上去很傻
· 因為標准跟我做的不一樣,所以標准通常看上去很傻
· 標准降低了創造力
· 標准在長期互相合作的人群中是沒有必要的
· 標准強迫太多的格式
1.4. 討論
許多項目的經驗能得出這樣的結論:采用編程標准可以使項目更加順利地完成。標准是成功的關鍵麼?當然不。但它們可以幫助我們,而且我們需要我們能得到的所有的幫助!老實說,對一個細節標准的大部分爭論主要是源自自負思想。對一個合理的標准的很少決定能被說為是缺乏技術**的話,那只是口味的原因罷了。所以,要靈活的控制自負思想,記住,任何項目都取決於團隊合作的努力。
1.5. 解釋
1.5.1. 標准實施
首先應該在開發小組的內部找出所有的最重要的元素,也許標准對你的狀況還不夠恰當。它可能已經概括了 重要的問題,也可能還有人對其中的某些問題表示強烈的反對。無論在什麼情況下,只要最後順利的話,人們將成熟的明白到這個標准是合理的,然後其他的程序員們也會發現它的合理**,並覺得帶著一些保留去遵循這一標准是值得的。如果沒有自願的合作,可以制定需求:標准一定要經過代碼的檢驗。如果沒有檢驗的話,這個解決方案僅僅是一個建立在不精確的基礎上的一大群可笑的人。
1.5.2. 認同觀點
1. 這行不通;
2. 也許可行吧,但是它既不實用又無聊;
3. 這是真的,而且我也告訴過你啊;
4. 這個是我先想到的;
5. 本來就應該這樣。
如果您帶著否定的成見而來看待事物的話,請您保持開放的思想。你仍可以做出它是廢話的結論,但是做出結論的方法就是你必須要能夠接受不同的思想。請您給自己一點時間去做到它。
1.5.3. 項目的四個階段
1. 數據庫結構
2. 設計
3. 數據層
4. HTML層
2. 命名規則
2.1. 合適的命名
命名是程序規劃的核心。古人相信只要知道一個人真正的名字就會獲得凌駕於那個人之上的不可思議的力量。只要你給事物想到正確的名字,就會給你以及後來的人帶來比代碼更強的力量。別笑!
名字就是事物在它所處的生態環境中一個長久而深遠的結果。總的來說,只有了解系統的程序員才能為系統取出最合適的名字。如果所有的命名都與其自然相適合,則關系清晰,含義可以推導得出,一般人的推想也能在意料之中。
如果你發覺你的命名只有少量能和其對應事物相匹配的話, 最好還是重新好好再看看你的設計吧。
2.2. 類命名
· 在為類(class )命名前首先要知道它是什麼。如果通過類名的提供的線索,你還是想不起這個類是什麼的話,那麼你的設計就還做的不夠好。
· 超過三個詞組成的混合名是容易造成系統各個實體間的混淆,再看看你的設計,嘗試使用(CRC Session card)看看該命名所對應的實體是否有著那麼多的功用。
· 對於派生類的命名應該避免帶其父類名的誘惑,一個類的名字只與它自身有關,和它的父類叫什麼無關。
· 有時後綴名是有用的,例如:如果你的系統使用了代理(agent ),那麼就把某個部件命名為“下載代理”(DownloadAgent)用以真正的傳送信息。
2.3. 方法和函數命名
· 通常每個方法和函數都是執行一個動作的,所以對它們的命名應該清楚的說明它們是做什麼的:用CheckForErrors()代替ErrorCheck(),用DumpDataToFile()代替DataFile()。這麼做也可以使功能和數據成為更可區分的物體。
· 有時後綴名是有用的:
o Max - 含義為某實體所能賦予的最大值。
o Cnt - 一個運行中的計數變量的當前值。
o Key - 鍵值。
例如:RetryMax 表示最多重試次數,RetryCnt 表示當前重試次數。
· 有時前綴名是有用的:
o Is - 含義為問一個關於某樣事物的問題。無論何時,當人們看到Is就會知道這是一個問題。
o Get - 含義為取得一個數值。
o Set - 含義為設定一個數值
例如:IsHitRetryLimit。
2.4. 縮寫詞不要全部使用大寫字母
· 無論如何,當遇到以下情況,你可以用首字母大寫其余字母小寫來代替全部使用大寫字母的方法來表示縮寫詞。
使用: GetHtmlStatistic.
不使用: GetHTMLStatistic.
理由
· 當命名含有縮略詞時,人們似乎有著非常不同的直覺。統一規定是最好,這樣一來,命名的含義就完全可以預知了。
舉個NetworkABCKey的例子,注意C是應該是ABC裡面的C還是key裡面的C,這個是很令人費解的。有些人不在意這些,其他人卻很討厭這樣。所以你會在不同的代碼裡看到不同的規則,使得你不知道怎麼去叫它。
例如
class FluidOz // 不要寫成 FluidOZ
class GetHtmlStatistic // 不要寫成 GetHTMLStatistic
2.5. 類命名
· 使用大寫字母作為詞的分隔,其他的字母均使用小寫
· 名字的首字母使用大寫
· 不要使用下劃線(_)
理由
· 根據很多的命名方式,大部分人認為這樣是最好的方式。
例如
class NameOneTwo
class Name
2.6. 類庫命名
· 目前命名空間正在越來越廣泛的被采用,以避免不同廠商和團體類庫間的類名沖突。
· 當尚未采用命名空間的時候,為了避免類名沖突,一般的做法是在類名前加上獨特的前綴,兩個字符就可以了,當然多用一些會更好。
例如
John Johnson的數據結構類庫可以用Jj做為前綴,如下:
class JjLinkList
{
}
另一種折中方式是建立包含類庫目錄(事實上Java也是這麼做的),以不通的目錄代表不同的命名空間。
例如
Microsoft的數據庫相關類庫可以在:
/classes/com/Microsoft/ Database/DbConn.php
Apache的數據庫相關類庫可在:
/classes/org/apache/Database/DbConn.php
2.7. 方法命名
· 采用與類命名一致的規則
理由
· 使用所有不同規則的大部分人發現這是最好的折衷辦法。
例如
class NameOneTwo
{
function DoIt() {};
function HandleError() {};
}
2.8. 類屬**命名
· 屬**命名應該以字符‘m’為前綴。
· 前綴‘m’後采用於類命名一致的規則。
· ‘m’總是在名字的開頭起修飾作用,就像以‘r’開頭表示引用一樣。
理由
· 前綴m防止類屬**和方法名發生任何沖突。你的方法名和屬**名經常會很類似,特別是存取元素。
例如
class NameOneTwo
{
function VarAbc() {};
function ErrorNumber() {};
var $mVarAbc;
var $mErrorNumber;
var $mrName;
}
2.9. 方法中參數命名
· 第一個字符使用小寫字母。
· 在首字符後的所有字都按照類命名規則首字符大寫。
理由
· 可以區分方法中的一般變量。
· 你可以使用與類名相似的名稱而不至於產生重名沖突。
例如
class NameOneTwo
{
fu