前端规范-脚本模块.docVIP

JavaScript模块 分类 全局 采用面向对象的思想，将公共的方法，集成到一个文件中。比如，基础组件，项目组件。 页面 整合页面功能模块，合并在一起。 书写规范 位置顺序 通常情况下，JavaScript 代码是和 HTML 代码一起使用的，可以将 JavaScript 代码放置在 HTML 文档的任何地方。但放置的地方，会对 JavaScript 代码的正常执行会有一定影响，具体如下所述。 放置于head/head之间 将 JavaScript 代码放置于 HTML 文档的 head/head 标签之间是一个通常的做法。由于 HTML 文档是由浏览器从上到下依次载入的，将 JavaScript 代码放置于head/head 标签之间，可以确保在需要使用脚本之前，它已经被载入了 放置于body/body之间 也有部分情况将 JavaScript 代码放置于 body/body 之间的。由于HTML文档是由浏览器从上到下依次载入，为了避免 JavaScript 代码操作 HTML 元素时，HTML 元素还未载入而报错（对象不存在）和阻塞加载时，我们需要将代码放在/body后面来避免这个问题。 总结 对于没有特殊要求或位置顺序不会导致错误的情况下，内嵌js放在head标签中，外部js放在/body之前。 命名 命名对于任何一种编程语言都是必须，命名的好坏，是否规范，可以直接直接影响代码的可读性。对于命名必要要具有语义化，严禁a,b之类的。 变量命名：驼峰式命名，在原生JavaScript变量要求纯英文字母，首字母必须小写，如:getNum;jQuery变量要求首字母为’$’,其他与原生JavaScript规则相同，如:$length; 函数命名：首字母小写驼峰式命名。如：setName(); 类命名：首字母大写，驼峰式命名。如：MyCar; 文件命名：独立js文件命名必须要有语义化 其他 文件编码统一为utf-8，每行代码结束必须有分号; 尽量避免使用存在兼容性及消耗资源的方法或熟悉，比如：eval(); 注重与HTML分离，减小reflow,注重性能; 代码结构清晰，加适量注释，提高函数重用率； 自定义插件的命名同样根据功能来命名。SuperSlide.js； 代码结构清晰，高内聚低耦合； 类，函数，自定义插件，及业务逻辑复杂的地方，必须有详细的注释； 涉及到公共方法或使用频率很高，必须封装到公共js库中，减少代码冗余。 注释 注释的作用是提高代码的可读性，帮助自己和别人阅读和理解你所编写的JavaScript代码，提高工作效率，注释的内容不会在网页中显示。注释可分为单行注释与多行注释两种。 单行注释 说明：单行注释以两个斜线开始，以行尾结束。 语法：//这是单行注释 使用方式： ① 单独一行：//(双斜线)与注释文字之间保留一个空格。② 在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。 ③ 注释代码：//(双斜线)与代码之间保留一个空格。 ① 若开始(/*)和结束(*/)都在一行，推荐使用单行注释。 ② 若至少三行注释时，第一行为/*,最后行为*/，并且注释文字与*保留一个空格。 示例： /* * 代码执行到这里会调用setAge()函数 * setAge():设置年龄，传入的参数为：Number类型 * 无返回值 * */ setAge(); 函数(方法)注释 说明：函数(方法)也是多行注释的一种，但是包含了特殊的注释要求，采用Javadoc方式。 语法： /* * 函数说明 * @param 参数名 {参数类型} 描述信息 * @param 参数名 {参数类型} 描述信息 * */ 示例： /* * 求和函数 * @param num1 {Number} 参与求和运算的值 * @param num2 {Number} 参与求和运算的值 * @return {Number} 求和的结果 * */ function sum(num1,num2){ //to do //参数合法性··· return num1+num2; } UED-前端规范-jxl