JavaScript开发规范及经验总结.docVIP

一、页面调用规则 1.原则上整个网站都用到的JS代码，放到配置文件里，统一命名为commons.js / aisncommons.js 等等。 2.原则上只有某个Channel用到的JS文件，放在该Channel里的layout上引用，用Channel名来命名。不要放到全网站（比如minisite, join flow等等） 3.原则上只有当前单个页面用到的JS， 就写在页面里，不要单独新建JS文件。如果该JS影响到SEO，则新建JS文件。 4.原则上JS不输出内容，仅控制页面行为。（例如JS可进行check box的select all操作，但是不允许输出check box的内容） 二、兼容性规则： 提倡开发人员以兼容所有浏览器为荣，在确实无法实现的情况下，再考虑以下兼容表（以下说的 x%的浏览器 指有x%的PV由该浏览器产生），该数据每三月取一次，定期更新。兼容度浏览器备注。完全兼容IE 6、 FF1.5 IE7必须支持主功能，查看重要信息，允许辅助功能不可用。FF 1.0、Safari例如必须保证search、feed back、注册、post product等主要功能可用，但是如My Recent History等允许不可用。可查看网站重要信息1%以下, 或客户端禁用JS、设置高安全级别等不做兼容调试 三、命名规则（以工程师手册为基准）： ①一般原则： 1.简单明确，见名知意，统一规范。使用较短的英文单词全称，不使用首字母或则缩写，除非缩写被广泛应用，如HTML、URL。 2.使用正确的英文单词和语法。 3.即使是随机访问者也能明白其用意。 ②变量、方法（类）名： 1.采用每个内部单词首字母大写，其余字母小写的格式。例如：strUserName 2.临时数字变量i j k m n ,字符串变量c d e 3.常量以及全局变量名必须全部使用大写字母 。 4.变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下： 5.数字变量：i //js不允许显式声明int, 数字以Number这个对象来管理, 因此所有数字都用i做前缀 6.对象引用变量：o //object 7.HTML DOM 变量：d //document 8.字符串变量:s //string 9.数组变量:a //array 10.Date类型变量：dtm 11.变量名必须采用有意义的单词命名，如：sUserName、iUserAge 12.如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如：var sAdName //用于表示Administrator帐户的名称 var sAdminName //不用给出注释，Admin被广泛了解 ③变量使用规范 1.变量使用前必须定义。没有定义的变量禁止使用 2.变量的使用尽量缩小到小的作用域。如循环使用 //这点很重要for(var i=0;i12;i++){?}? ?? ?? ?? ? 而不是：? ?? ?? ?? ? var? ?i;? ?? ?? ?? ? for(i=0;i12,i++){? ?? ?? ?? ? } ④对象命名规范 如果在代码中，需要强调对象的类型，参考本命名规则各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀： 1.text输入框:txt 2.button按钮：btn 3.select下拉选择框：sel 4.option项pt 5.form表单：frm 6.frame框架：fra 7.hidden表单项：hdn 8.div标记：div 9.span标记:span 10对话框对象:dlg 11.窗口对象：win ⑤函数以及子过程命名规范 1.函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能 2.函数命名的动词前缀必须是同函数功能相关的完整动词 3.函数命名第一个单词的首字母小写，后面每一个单词的首字母大写 ⑥文件命名： 1.字母全部采用小写，单词之间用下划线_分隔 2.采用频道名+模块，例如minisite_menu.js。如果全站使用，则采用模块名，如menu.js 四、其他规则 1.必须按照标准来写触发事件，比如onClick等，需注意大小写。建议关闭UE中的自动修改功能。 2.原则上不允许写死循环，看起来很可笑的规则，但是在写JS程序时常会碰到，因为在JS中常使用死循环来创造实时更新的效果。 3.在调用的JS文件中，除了变量申明外，不允许有执行部分，必须在HTML中触发或者调用。直接写在HTML代码中或者单个页面使用的JS不在此列。 4.使用JS前请综合考虑HTML、CSS、JS、后台程序