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

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