2.编程规范及代码格式及分布.docx

编程规范及代码格式及文件分布架构选择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/自定义公用函数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/文件规范a) 文件夹和文件名全部小写，第三方的不管了。b) 命名在能表述清楚并区分的情况下尽量简短，最好能简单注释一下用途,写入当前文件夹下的readme.txt或该文件里面注释。c) 相关文件夹放在一起，参照上面的目录结构存放。d) 文件多个词以”_”分割，如member_model.php，user_login.js。数据库规范a) 数据库名小写，字符集utf8 - UTF-8 Unicode，排序规则utf8_general_ci，如comm。b) 命名在能表述清楚并区分的情况下尽量简短可缩写，且必须有注释备注，如addr。c) 表名全小写，多个词以”_”分割，要注释，如 yg_user 用户表。d) 字段命名全小写，多个词以”_”分割，要注释，如 user_id 用户id。e) 中英混编的情况尽量使用能表述清楚并区分其它名称的名称，如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. 数字,时间戳int(11)iii. 小数字类型tinyint(1) 如只有0，1几个值的iv. 备注，内容等text不确定长度又很长的v. 时间类型datetime最好直接varchar(50),防止出现0000-00-00 00:00:00时间戳与datetime兼顾考虑?e) 某些字段在很多表中都有，要保持一致，如addr,realaddr,resaddrf) 表的引擎，默认设置 MyISAM（不支持事务，执行速度快，索引数据分离），需要事务处理的才设置为InnoDB.编程规范a) 命名在能表述清楚并区分的情况下尽量简短可缩写。b) 函数名采用全小写下划线分割法，如 function user_add()。c) 私有不对外函数以”_”开头，如_get_user。d) 常量，全局变量全大写字母，如 URL,ROOT。e) 保持良好的代码书写规范，合理使用缩进，保持代码美观。f) 请不要使用$data1,$data2,function m1(),function m2()之类的。g) 一个方法只完成一项功能。h) 代码块不宜太大，避免造成过于庞大的单个类或函数，也不宜太细，避免类的继承太深或函数调用太多，相关类或函数控制在5个以内。i) 变量先声明在赋值使用$number=0;$string=; $arr=array(); $arr“key”=”val”;j) Php与Html与js分离。在html里面只简单使用。通过事件绑定来执行点击事件,$(.classname).click(function() dosomething() );k) Html标签带数据使用data-开头,如 morel) 函数尽量描述其作用,公用函数必须描述,采用phpdoc注释的标准文档。如下/*查询指定用户信息*param id用户id*return array|boolen用户数组，失败返回false;*/function user_add()m) 一般函数内部不需要注释，除非非常必要是编写注释。n) 修改函数后注意修改上面的描述及用途。o) 注意代码格式化，对齐。p) 全部 后面的不换行。举例其他1. 二级文件夹放入.htaccess如modules/.htaccess 禁止浏览器访问此目录下的文件，加入文件内容 Deny from all2. 每个目录最好能建立一个