JAVASCRIPT企业项目开发规范(总结)_V1.0.pdf

JavaScript 规范 一、概要 程序通常是由很多部分组成，表现为函数、语句和表达式，它们必须准确无误地按照顺 序排列。 但是，在软件的产品生命周期中，程序通常都会被修改。优秀的程序拥有一个前瞻性的 结构，他能遇见在未来才可能需要的修改 （拓展性），但不会让其成为过度的负担。优秀的 程序还具备一种清晰的表达方式。在多人开发的项目中，如果一个程序被表达得很好，开发 人员就能更加容易地去理解它，以便成功地改造和修补它 （代码风格）。 JavaScript 的弱类型和过度的容错性，导致程序质量无法再编译时获得保证，所以，为 了弥补之歌缺陷，我们应该按照严格的规范进行编码。 JavaScript 自身也包含大量脆弱的、问题缠身的特性，它们会妨碍我们写出优秀的程序， 显然，在程序开发过程中，避免掉这些糟糕的特性，能让我们的代码更优秀。 对于一个组织机构来说，软件的长远价值和代码库的质量成正比。在程序的生命周期里， 会经历很多人的测试、使用和修改。如果一个程序能很清楚地传达它的结构和特性，那么， 当它在将来被修改的时候，它被破坏的可能性就小很多。 JavaScript 代码经常被直接发布。它应该始终具备发布质量，干净利落。通过在一个清 晰且始终统一的风格下编写，代码的阅读会变得更加的简单。 所以，并不是写出别人都看不懂的代码，才显得自己技术实力精湛。 因为，当程序可读性强的时候，它正常运行的可能性，以及是否准确按照我们的意图去 工作的可能性也会显著增强。它还决定了软件在其生命周期中是否进行扩展。如果我们能阅 读并且理解程序，那么就有希望去修改和完善它。 基于以上的几点，对项目开发过程中JavaScript 语言的编写做一些规范，无论是为了今 后代码的维护、修改或者拓展，以及代码的精简和复用，都是有一些好处存在的。下面的规 范可能没办法做到全面，但是也希望能够给项目的开发带来一些帮助，同时，也希望大家能 随时补充，并指正错误，十分感谢。 二、具体 1. js 文件引入 1.1 Common.js 文件：提取一个公共的js 文件，用于存放通用的js 函数代码，并引入 到所有的页面当中。 1.2 插件js，有些页面单独使用的插件js 会比较大，应该按需引入。 1.3 页面中的js 文件最好不要多余引入。 2. 尽量使用JavaScript 提供的标准方法和属性。 2.1 Array 对象： 2.2 Function 对象： 2.3 Object 对象： 2.4 RegExp 对象： 2.5 String 对象： 3. 代码风格： 3.1 缩进、空行。 3.2 注释: 3.2.1 可采用类似JAVA 的注释方式 （块注释 + 必要行注释）； 3.2.2 有利于在方法调用处看到方法的具体传参提示； 3.2.3 方便日后代码维护； 3.2.4 例如： /** * 交换数组两个值 *@param {Array} array 操作原数组对象 *@param {Number} formIndex 第一个值 *@param {Number} toIndex 第二个值 *@return { Array } 新数组 */ function arraySwap( array , formIndex, toIndex ) { var tem = array [formIndex ] ; array [formIndex ] = array [toIndex ]; array [toIndex ] = tem; return array; } 4. 命名规范。 推荐： 4.1 userName 4.2 user_name 4.3 动+名词组合：getUserName 4.4 构造器函数首字母大写：function Person() {...} 4.5 常量全用大写字母：var PI =