2.編程規(guī)范及代碼格式及分布.docx

編程規(guī)范及代碼格式及文件分布架構(gòu)選擇1. Win server :Wamp2.2e Apache2.2.22+mysql5.5.24+php5.3.132. Centos: ampps3.3 apache2.4.12+mysql5.6.25+php5.3.29+mongodb2.6.73. 后端codeigniter 2.2.1(ci核心)+MX(HMVC) 5.5 + PHPExcel 1.8.04. 前端 jquery1.8.3+easyui1.3.2+highcharts3.0.7(圖表)+ueditor1.3.6(編輯器)+ requirejs2.1.20(js模塊化)+openlayers2.13.1 (地圖)等源碼目錄結(jié)構(gòu)分布n comm/u system/ ci核心目錄u uploads/ 各種用戶上傳下載文件目錄l tiles/地圖地圖l photos/身份證，樓宇照片等u application/ 默認(rèn)應(yīng)用目錄l cache/緩存文件夾l config/ 配置文件夾l controllers/ 默認(rèn)控制器目錄l core/ 自定義核心功能l helpers/自定義公用函數(shù)l hooks/自定義鉤子l libraries/ 默認(rèn)公用類l models/ 默認(rèn)模型目錄l third_party/第三方擴(kuò)展目錄n mx/hmvc核心源碼l view/默認(rèn)視圖目錄u modules/ hmvc模塊目錄，后端基本都在這里l welcome/ 模塊文件夾，每個(gè)大功能一個(gè)文件夾,下面各自的mvcln controllers/該模塊下的控制器n models/該模塊下的模型, $this-load-model()n view/該模塊下的視圖, $this-load-view()n libraries/該模塊下的共用類, $this-load-library()l map/u static/ 公用目錄,前端的js,css都在這里,html在視圖里面l css/ css樣式l images/l easyui/l highcharts/l js/ js模塊目錄n welcome/ 功能模塊名，一個(gè)大功能一個(gè)文件夾n member/n common/n login.js有些簡(jiǎn)單也可以直接放在目錄下l jslib/ 存放jquery.js, require.js之類的單個(gè)文件l map/OpenLayers文件夾l ueditor/文件規(guī)范a) 文件夾和文件名全部小寫，第三方的不管了。b) 命名在能表述清楚并區(qū)分的情況下盡量簡(jiǎn)短，最好能簡(jiǎn)單注釋一下用途,寫入當(dāng)前文件夾下的readme.txt或該文件里面注釋。c) 相關(guān)文件夾放在一起，參照上面的目錄結(jié)構(gòu)存放。d) 文件多個(gè)詞以”_”分割，如member_model.php，user_login.js。數(shù)據(jù)庫(kù)規(guī)范a) 數(shù)據(jù)庫(kù)名小寫，字符集utf8 - UTF-8 Unicode，排序規(guī)則utf8_general_ci，如comm。b) 命名在能表述清楚并區(qū)分的情況下盡量簡(jiǎn)短可縮寫，且必須有注釋備注，如addr。c) 表名全小寫，多個(gè)詞以”_”分割，要注釋，如 yg_user 用戶表。d) 字段命名全小寫，多個(gè)詞以”_”分割，要注釋，如 user_id 用戶id。e) 中英混編的情況盡量使用能表述清楚并區(qū)分其它名稱的名稱，如yg_user,xf_info。f) 每個(gè)表都記錄時(shí)間，自動(dòng)記錄增加修改時(shí)間。timestamp timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,g) 字段類型定義i. 普通字符varchar(50)長(zhǎng)度自定20,100都行，長(zhǎng)度最好能預(yù)留大些，超過(guò)255，請(qǐng)使用text.ii. 數(shù)字,時(shí)間戳int(11)iii. 小數(shù)字類型tinyint(1) 如只有0，1幾個(gè)值的iv. 備注，內(nèi)容等text不確定長(zhǎng)度又很長(zhǎng)的v. 時(shí)間類型datetime最好直接varchar(50),防止出現(xiàn)0000-00-00 00:00:00時(shí)間戳與datetime兼顧考慮?e) 某些字段在很多表中都有，要保持一致，如addr,realaddr,resaddrf) 表的引擎，默認(rèn)設(shè)置 MyISAM（不支持事務(wù)，執(zhí)行速度快，索引數(shù)據(jù)分離），需要事務(wù)處理的才設(shè)置為InnoDB.編程規(guī)范a) 命名在能表述清楚并區(qū)分的情況下盡量簡(jiǎn)短可縮寫。b) 函數(shù)名采用全小寫下劃線分割法，如 function user_add()。c) 私有不對(duì)外函數(shù)以”_”開(kāi)頭，如_get_user。d) 常量，全局變量全大寫字母，如 URL,ROOT。e) 保持良好的代碼書寫規(guī)范，合理使用縮進(jìn)，保持代碼美觀。f) 請(qǐng)不要使用$data1,$data2,function m1(),function m2()之類的。g) 一個(gè)方法只完成一項(xiàng)功能。h) 代碼塊不宜太大，避免造成過(guò)于龐大的單個(gè)類或函數(shù)，也不宜太細(xì)，避免類的繼承太深或函數(shù)調(diào)用太多，相關(guān)類或函數(shù)控制在5個(gè)以內(nèi)。i) 變量先聲明在賦值使用$number=0;$string=; $arr=array(); $arr“key”=”val”;j) Php與Html與js分離。在html里面只簡(jiǎn)單使用。通過(guò)事件綁定來(lái)執(zhí)行點(diǎn)擊事件,$(.classname).click(function() dosomething() );k) Html標(biāo)簽帶數(shù)據(jù)使用data-開(kāi)頭,如 morel) 函數(shù)盡量描述其作用,公用函數(shù)必須描述,采用phpdoc注釋的標(biāo)準(zhǔn)文檔。如下/*查詢指定用戶信息*param id用戶id*return array|boolen用戶數(shù)組，失敗返回false;*/function user_add()m) 一般函數(shù)內(nèi)部不需要注釋，除非非常必要是編寫注釋。n) 修改函數(shù)后注意修改上面的描述及用途。o) 注意代碼格式化，對(duì)齊。p) 全部 后面的不換行。舉例其他1. 二級(jí)文件夾放入.htaccess如modules/.htaccess 禁止瀏覽器訪問(wèn)此目錄下的文件，加入文件內(nèi)容 Deny from all2. 每個(gè)目錄最好能建立一個(gè)