PHP項(xiàng)目開發(fā)規(guī)范文檔

1、php項(xiàng)目開發(fā)規(guī)范文檔1. 文件及文件目錄規(guī)范1. 命名規(guī)范文件名以全部小寫的英文字母組成，建議使用英文單詞，必要時(shí)使用復(fù)數(shù)；多個(gè)單詞 z間以下劃線隔開，類文件建議以類的名字的小寫命名;則這不僅僅是php文件，包 括整個(gè)項(xiàng)目的文件.例：一般常見文件：comm on .php, con fig.php login.php, user_i nfo.htm, import_categories.php類文件class.acco unts.php =>class accoun ts ;2. 目錄結(jié)構(gòu)規(guī)范目錄的命名同文件名一樣，英文字母，全部小寫例：/lib常用ph p文件,庫(kù)文件/imag es

2、頁(yè)面上使用的背景圖或圖標(biāo)文件存在目錄/js頁(yè)面上使用的js文件/languages語(yǔ)言包文件/template s模板文件存在目錄/c ache站點(diǎn)數(shù)據(jù)存儲(chǔ)冃錄,比如像日志,附件,配置文件等，均可以創(chuàng)建子目錄存放在 這該目錄下;2. 變量規(guī)范2.1變量命名2.1.1 form域命名及url參數(shù)名命名考慮到php的數(shù)組下標(biāo)(ke y)的應(yīng)用是區(qū)分大小寫的，所以強(qiáng)制全部采用小寫字母 組成，多詞組成時(shí)可以用減號(hào)隔開.2.1.2變量命名$ +變量類型一變量命名作為規(guī)則，變量命名采用英文單詞，多詞組成吋用下劃線連 接;變量類型不一定強(qiáng)制！必須用小寫.例:$ta ble_namephp常用的類型：stri

3、ng str 例：$s tr_username,$str_passwo rd,$passwordinteger in t 例：$int_id ,$idfloat fit 例：$fl t_money,$mon eydouble d bl«列：$dbl_p ie,$pieboole an bln 例:$bln_issetarr ay arr 例：$arr_data,$dataphp用于全局變量類型：$globa i即全局變量的配置變量，全局變量首字母用大寫php常量首全部用大寫defined(*i n_olcms * )2.2變量的初始化php木身并沒(méi)有對(duì)初始化變量的名字.所以我們能做的

4、就是給一個(gè)未使用的賦一個(gè)空值.例：$arrdata =array();$in tquality = 0 ;3. 函數(shù)與類規(guī)范1. 函數(shù)的命名下劃線連接的組合規(guī)則，例init () , li st_category ()2. 類的命名規(guī)范3.2.1類的命名類的命名也采用首字母大寫的組合規(guī)則.例class user s .3.2.1類成員的命名類的成員函數(shù)也采用小寫的組合規(guī)則，但為了避免函數(shù)名過(guò)長(zhǎng),可以靈活結(jié)合類的名 字命名例如users:de lete($uid)即用戶類的成員函數(shù)用戶刪除函數(shù)4. 語(yǔ)法規(guī)范表達(dá)式、流程控制語(yǔ)句中，關(guān)鍵字之間用一個(gè)空格隔開.且一致釆用小寫字母編寫各類 語(yǔ)句！例如:

5、以下空格以紅色背景突顯 ifj($blnst atus|=|true ) . $ar rdata|=|arra y();在zend st udo按下ctr+s hift+f格式代碼5. 注意事項(xiàng)1 借助get_mag ic_quotes_gp c()判斷php環(huán)境中是否對(duì)外部變量進(jìn)行自 動(dòng)轉(zhuǎn)義，如若沒(méi)有，則要手工進(jìn)去轉(zhuǎn)義，以防sql注入.2. 避免使用 include_once/require _once3. 編碼過(guò)程中需?？s進(jìn)時(shí)，縮進(jìn)采用鍵盤tab鍵，不采用空榕鍵，縮進(jìn)字符數(shù)設(shè)定為4 個(gè)字符4. 用于運(yùn)算的變量，比如$i, $k等時(shí)，請(qǐng)注意使用完后unset($i,$k)避免上下 文的重復(fù)使

6、用而并沒(méi)有使用到初始值.5. 必須對(duì)外部變量進(jìn)行判斷，比如類型，可允許的最大長(zhǎng)度或最小值，尤其 是與數(shù)據(jù)庫(kù)結(jié)合應(yīng)用時(shí)，要根據(jù)數(shù)據(jù)庫(kù)的字段類型，長(zhǎng)度來(lái)判斷檢查對(duì)外 部變量的引用。避免出現(xiàn)sql錯(cuò)誤.6. 操作文件或目錄時(shí)，必須精準(zhǔn)，建議使用is_dir,is_file, fil e_exists等函數(shù)結(jié) 合檢驗(yàn)，操作目標(biāo)是否為預(yù)定目標(biāo)！避免賬戶操作了不該操作的文件或fi 錄7. 向頁(yè)面輸出數(shù)據(jù)時(shí)，要注意是否需要html過(guò)濾，或url轉(zhuǎn)換，避免產(chǎn)生 不必要的麻煩或界面上的影響！8. 在字符串中引用變量，建議使用以下兩種方法$strsql =zselect u serid from'.$ta

7、blename;/(最佳選擇)或$s trsql 二"sei ect userid f rom stablen ame"或$strs ql =sprint(zselect user id from %s,$tablename);9. 編寫sql語(yǔ)句時(shí)，可以使用引用符mysql的引用符為'、mssql的引用符為例my sqlselect 'userid' fro m users'mss ql:select userid from users注：mt yslq里的關(guān)鍵字，用大小，分析日志方便10. 錯(cuò)誤與異常的處理友好的錯(cuò)誤或是錯(cuò)誤口志記錄是非常重要的。11. 清除不必要的附件文件.我們?cè)谠O(shè)計(jì)功能時(shí)，經(jīng)常使用了一些附件文件，比如產(chǎn)品圖像，而往往在刪除處理, 尤其是批量刪除時(shí)，會(huì)忽略了這些附帶的文件.5.12我們只兼容php5,不再對(duì)php4進(jìn)行支持，所以一些php4固有的函數(shù)或特性，強(qiáng)制 不再使用.1. 數(shù)據(jù)庫(kù)的各類命名規(guī)范由于mysql是不區(qū)分大小寫的，所以我們強(qiáng)制所有的命名規(guī)則都是小寫的英文字母， 比如db_s sp.members為數(shù)據(jù)庫(kù)db_ssp的用八表.多詞時(shí)以下劃線隔開，這也是我們唯 一建議使用下劃線的地方，例：db_ssp.members_infos 用戶信息d b_ssp.trad