研发代码规范 2017.12.7 手写初版

正文开始

js<br />局部事件要闭包写,不能被外界调取和影响外界;<br />获取标签用class或id或标签名字[属性值],禁止直接这样找:$('span')。<br />dom操作要遵循先定义要操作的模块,再从父到子依次find操作,在有相同的父容器时,禁止直接全局操作某个标签。<br />获取父标签时:禁止直接parent() siblings() 这样的模糊定义,建议用:$(parents('.xxxx')[0]) 这样精准定位父标签。<br /><br />js生成html遵循完整原则,多行html用+分行 或"分行 禁止在html里写逻辑判断,要在循环中判断好再生成变量。<br />js特效实现先和大家探讨目前平台是否支持扩展,尽量少用第三方的插件。<br />js里不能写php,用到的全局变量在前面统一写好。<br />js操作dom要针对具体对象,bad: parentObj.('click', '.xxx,.ddd', func())<br />同一个模块的代码要写在一起 不要跨越其他模块.<br />初始化事件写在js末尾.<br /><br /><br />类规则:<br />平台用到的数据、系统值,要在类里静态定义,相同的值只能定义1次。<br />变量、函数:<br />驼峰格式,支持拼音英文,但不能语义模糊、意思交叉。<br />变量、函数的意思必须直观可读,备注无需太多但必须要有。<br />函数返回值要统一回调,如true,string,[]必须统一,复杂的回调格式如[]要备注格式。<br /><br />    /**<br />     * 根据服务商id获取其支持的运输方式<br />     *<br />     * @access public<br />     * @param int $fws_id    服务商id<br />     * @param bool $orderBaoyou    订单是否满足包邮<br />     * @return array 返回类型 [顺丰快递, 普通快递, 顺丰到付]<br />     */<br /><br /><br />平台内用到的值必须调取类里的,禁止在外部(htm模块js中)直接写具体的值和平台的运算规则。<br />类里要定义好系统的规则,备注清晰,不能有歧义。每个函数只能最多做2件事,能只做1件的就不要多件事写在一起,具体只做了1件事的就不能强行分离多个函数来完成,函数输出内容最多3组。<br />多次需要用到的函数必须封装 支持复用。<br /><br /><br />模块:<br />实现一个功能时 先梳理思路,在每个不同的环节中写好备注,过程中的变量取名字要避免歧义、冲突、模糊。<br />循环中输出的内容要在类里做好规则运算,不能在模块里判断取值,必须为前端输出各种可能出现的内容,无须前端做判断。<br />身份操作数据要对身份做切换校验,防止修改他人数据。<br />单个模块建议1000行,其他可独立的功能尽量独立分离一个模块。<br />数据处理要考虑缺省或特殊情况如未完善资料,或资料格式不按套路填写,防止其他情况抛出报错。<br />模块中不能直接写数据操作。<br /><br /><br />参数:<br />传参不建议用大小写,建议用下划线格式。<br />获取值的类型要匹配 int array trim ,<br />语义不直观或有歧义的参数要备注其意义。<br />某些情况可缺省的值要备注理由。<br />不能为空的值要备注 或在最前面做拦截。<br />数组要备注其例子以作参考。<br /><br />模块里不能排版table或块状div布局。<br /><br /> <br />html<br />标签排版遵循父包子原则,带上特殊的id或class,方便js操作和css样式块状维护。html里不能直接文本输出平台规则的值,要从类里调取。<br /><br /><br />数据库<br />表名字不能说明功能的表要备注其功能。<br />字段统一用一个字母加下划线作前缀<br />字段中禁止大写<br />字段格式要合理,唯一的数据要加唯一索引,<br />需要查询的数据要索引,索引顺序依据主字段到细字段排序。<br />字段的语义如果不是简单类型或有隐藏、多种意义,要备注清楚,有参与运算的字段要备注清楚,防止他人采坑。<br />字段有格式要求的,备注例子。<br /><br /><br />实现方式不合理或有待优化的自行优化完成,自行安排加班或打包回家处理。<br />开发过程中遇到别人遗留的问题可以提醒原作者或自行修改,但不能继续重蹈覆辙。<br />代码习惯都是靠平日积累,鼓励大家创新和改进。<br /><br />

正文结束

阿里云、腾讯云 apache的vhost配置https HTTP Content-type常用对照表