PHP代碼編寫規范_第1頁
PHP代碼編寫規范_第2頁
PHP代碼編寫規范_第3頁
PHP代碼編寫規范_第4頁
PHP代碼編寫規范_第5頁
已閱讀5頁,還剩4頁未讀 繼續免費閱讀

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內容提供方,若內容存在侵權,請進行舉報或認領

文檔簡介

1、PHP代碼編寫規范一、編輯器設置(1)使用Tab縮進,不要使用空格鑒于很多編輯器在保存文件時會自動清除用于縮進的空格,所以我們一律使用Tab鍵進行縮進。(2)UNIN文件格式請將編輯器設置對所有程序使用UNIX格式保存,不要使用Win32或者Mac的格式。例如,EditPlus里面Document-File Format(CR/LF)-Unix 。對于windows格式文件,以Ctrl + M結束(vim下為M),需要過濾掉:$text = strtr($text, x0D, );二、命名設置1、公共庫名稱空間TPLIB,Tencent PHP Library2、變量命名(1)所有字母都使用小

2、寫(2)首字母根據變量值類型指定整數I、浮點數f、字符串s、布爾值b、數組a、對象o、資源r、混合類型m(3)使用_作為每一個詞的分界例如:$i_age_max = 10;$f_price = 22.5;$s_name =harry;$b_flag = true;$a_price = array();$o_object = new class();$r_file = fopen();$m_var = array_combine($a_name, $a_flag);3、類命名(1)使用大寫字母作為詞的分隔,其他的字母均使用小寫,即駝峰格式。(2)名字的首字母使用大寫(3)不要使用下劃線(_)(4

3、)interface接口最好使用大寫字母I,并以Interface結尾例如:class NameOneTwoclass Nameinterface IExampleInterface ()4、方法命名(1)使用大寫字母作為詞的分隔,其他的字母均使用小寫(2)名字的首字母使用大寫,聲明為 “private” 或 “protected” 的,使用_為前綴(3)不要使用下劃線(_)(4)與類命名一致的規則(5)對象的訪問器總是以 “get” 或 “set” 為前綴,當使用設計模式如 單態模式(singleton)或工廠模式(factory),方法的名字應當包含模式的名字,這樣容易從名字識別設計模式。

4、例如:class NameOneTwopublic function DoIt() ;protect function _HandleError() ;private function _SayHello() ;5、類屬性命名(1)屬性名前綴應以屬性值類型指定(具體參照變量命名規則)(2)前綴后采用與類命名一致的規則(3)私有屬性采用_為前綴例如:class NameOneTwo public function VarAbc() ;public function ErrorNumber() ;public $iAge;private $_iAge;6、方法中參數命名(1)參照類屬性命名例如:c

5、lass NameOneTwo public function VarAbc($sMsg) ;7、全局變量(1)全局變量應該帶前綴g(2)其余參照變量命名規則例如:global $gi_Age;global $ga_Price8、 定義命名/全局常量(1)全局常量使用_分割每個單詞(2)所有字母使用大寫例如:define(E_ERROR_MISSING_PARA, 501);9、 函數(1)所有的字母采用小寫,使用_分割每個單詞例如:function some_bloody_function()10、文件命名包含文件應該以.inc.php方式命名,例如config.inc.php。單獨類的文件

6、使用Classname.php方式命名,包中的類使用 PackageName/ClassName.php命名。三、代碼層1、大括號規則(1)將大括號放置關鍵詞下方的同列處或同行,推薦放到同行例如:function some_bloody_function() if (true) / code2、 縮進/制表符規則(1)使用制表符縮進例如:function some_bloody_function() if (true) /code3、小括號、關鍵詞和函數規則(1)不要把小括號和關鍵詞緊貼在一起,要用空格隔開它們(2)小括號和函數名要緊貼在一起(3)除非必要,不要在Return返回語句中使用小括

7、號例如:if (condition) strcmp($sHello, $sEvening);return 1;4、 If Then Else格式布局if (條件1) /注釋else if (條件2) /注釋else /注釋如果你有用到else if語句的話,通常最好有一個else塊以用于處理未處理到的其他情況。可以的話放一個記錄信息注釋在else處,即使在else沒有任何的動作。條件格式總是將恒量放在等號/不等號的左邊,例如:if ( 6 = $errorNum ) 一個原因是假如你在等式中漏了一個等號,語法檢查器會為你報錯。第二個原因是你能立刻找到數值,而不是在你的表達式的末端找到它。需要一

8、點時間來習慣這個格式,但是它確實很有用。5、Switch格式(1)default總應該存在,它應該不被到達,然而如果到達了就會觸發一個錯誤。(2)如果你要創立一個變量,那就把所有的代碼放在塊中。例如:switch ($numPeople) case 1:break;case 2:break;default:break;6、 ?:三元運算符(1)把條件放在括號內以使它和其他的代碼相分離。(2)如果可能的話,動作可以用簡單的函數。(3)把所做的動作,“?”,“:”放在不同的行,除非他們可以清楚的放在同一行。例如(condition) ? funct1() : func2();(condition)

9、? long statement: another long statement;7、 代碼塊的聲明(1)聲明代碼塊需要對齊。例如$iDate = 0;$irDate = NULL;$sName = ;$mName = NULL;8、 不要采用缺省方法測試非零值不要采用缺省值測試非零值,也就是使用:if (FAIL != f()比下面的方法好:if (f()即使FAIL可以含有0值,也就是PHP認為false的表示。在某人決定用-1代替0作為失敗返回值的時候,一個顯式的測試就可以幫助你了。就算是比較值不會變化也應該使用顯式的比較;例如:if (!($bufsize % strlen($str)

10、應該寫成:if ($bufsize % strlen($str) = 0)以表示測試的數值(不是布爾)型。一個經常出問題的地方就是使用strcmp來測試一個字符等式,結果永遠也不會等于缺省值。非零測試采用基于缺省值的做法,那么其他函數或表達式就會受到以下的限制:只能返回0表示失敗,不能為/有其他的值。命名以便讓一個真(true)的返回值是絕對顯然的,調用函數IsValid()而不是Checkvalid()。9、PHP注釋與方法解析(1)/單行注釋(2)/* * 多行注釋*/(3)/* * 多行文檔注釋 * */(4)關于文檔注釋的說明/* 這是一個關于函數的注釋 */function bac(

11、)/* 這不是一個文檔注釋,因為不是以/*開頭 */function bac()/* 這是一個文檔注釋,但與函數無關,因為他沒放到函數前面 */function bac()e) 文檔說明/* 文件說明* author 作者* license License* version 1.0* link* final*/10、在運算符之間使用空格在比較運算符(、=、=、=、=、!=、!=)、賦值運算符(=)、數學運算符(+、-、*、/、%)、位運算符(&、|、)、邏輯運算符(!、&、|)、冒號(:)、問號(?)、字符串連接運算符(.)、字符串連接賦值運算符(.=)前后,以及左括號(()前(函數調用例外)

12、、逗號(,)后請使用空格進行間隔。例如: /* These are all wrong. */$i=0;/* These are all right. */$i = 0; /* These are all wrong. */if($i7) ./* These are all right. */if ($i 7) . /* These are all wrong. */if ( ($i 8) ) ./* These are all right. */if ($i 8) . /* These are all wrong. */do_stuff($i,foo,$b);/* These are all right. */do_stuff($i, foo, $b);/* These are all wrong. */for($i=0; $i$size; $i+) ./* These are all right. */for ($i = 0;$i $size;$i+) . /* These are all wrong. */$i=($j $size)?0:1;/* These are all rightg. */$i = ($j $s

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網頁內容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經權益所有人同意不得將文件中的內容挪作商業或盈利用途。
  • 5. 人人文庫網僅提供信息存儲空間,僅對用戶上傳內容的表現方式做保護處理,對用戶上傳分享的文檔內容本身不做任何修改或編輯,并不能對任何下載內容負責。
  • 6. 下載文件中如有侵權或不適當內容,請與我們聯系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論