Javascript编程规范_js@param资源-CSDN文库

需积分: 9 165 浏览量 2018-06-28 15:36:05 上传评论收藏 25KB DOCX 举报

### JavaScript编程规范详解 #### 1. 介绍 ##### 1.1 为什么要有编码规范编码规范在软件开发过程中扮演着至关重要的角色。以下是几个关键的原因： - **提高维护效率**：根据软件工程的经验法则，一个软件项目的大部分生命周期成本（约80%）都集中在维护上。良好的编码规范有助于降低未来的维护成本。 - **增强可读性**：当项目由不同的开发者维护时，统一的编码规范使得代码更加易读，新加入的开发者能够更快地理解和接手项目。 - **确保高质量交付**：就像任何其他产品一样，源代码也需要经过精心设计和良好包装才能发布。编码规范帮助确保代码的质量和可维护性。 #### 2. 文件组织在JavaScript项目中，文件组织是非常重要的。以下是一些指导原则： - **独立文件**：JavaScript代码应保存在独立的`.js`文件中，而不是嵌入HTML文件内。这样不仅便于管理，还可以实现更高效的加载和缓存策略。 - **外部引用**：通过`<script type="text/javascript" src="path/to/file.js"></script>`来引入外部JavaScript文件，确保所有脚本文件都有正确的`type`属性定义。 - **放置位置**：为了减少页面加载时间，推荐将外部JavaScript文件放在HTML文档的`<body>`标签尾部。 #### 3. 缩进排版缩进的一致性和清晰度对于代码可读性至关重要： - **使用空格而非Tab**：使用4个空格作为缩进单位，避免使用Tab键。这是因为不同的编辑器对Tab的宽度解释不同，可能导致代码显示不一致。 - **一致性**：保持一致的缩进风格，即使会略微增加文件大小，但这对性能的影响几乎可以忽略不计，并且在代码压缩过程中会被消除。 #### 4. 行长度控制每行的字符数量有助于提高代码的可读性： - **行长度限制**：尽量让每行不超过80个字符。当一行代码过长时，可以在逗号后进行折行，以保持代码的清晰度。 #### 5. 注释合理的注释可以显著提升代码的可维护性： ##### 5.1 文件注释文件顶部的注释应包含版权信息、文件概述以及作者等信息。例如： ```javascript /** * Copyright MacroSAN Technologies Co., Ltd. All rights reserved. * * @fileoverview 该文件描述 * @author guolin 2015-08-12 */ ``` ##### 5.2 类注释对于类定义，应在类定义之前添加描述性的注释： ```javascript /** * @class 动物类 */ function clAnimal() { // ... } ``` ##### 5.3 函数注释对函数进行详细的注释，包括参数类型和返回值等信息，以便于其他开发者的理解和使用： ```javascript /** * 交换数组中的两个值 * @param {Array} aList 操作原数组对象 * @param {Number} nFromIndex 第一个值 * @param {Number} nToIndex 第二个值 * @return {Array} 新数组 */ function arraySwap(aList, nFromIndex, nToIndex) { var tTemp = aList[nFromIndex]; aList[nFromIndex] = aList[nToIndex]; aList[nToIndex] = tTemp; return aList; } ``` ##### 5.4 常量注释对于定义的常量，提供清晰的注释说明其用途和含义： ```javascript /** * 一分钟所代表的秒数 * @type {number} */ clUtil.SECONDS_IN_A_MINUTE = 60; /** * 每种单位所代表的秒数 * @type {Object.<number>} * @const */ clUtil.SECONDS_TABLE = { minute: 60, hour: 60 * 60, day: 60 * 60 * 24 }; ``` ##### 5.5 行末注释在代码行末添加必要的注释以提供额外的信息： ```javascript var sName = "animal"; // 动物名称 ``` #### 6. 语句 ##### 6.1 变量使用`var`关键字来声明变量以避免作用域问题： - **显式声明**：声明变量时必须使用`var`关键字。未使用`var`声明的变量会导致作用域问题，容易与其他变量发生冲突。 - **作用域**：明确指定变量的作用域，防止不必要的全局变量污染。 ##### 6.2 常量遵循特定的命名规则来定义常量： - **命名约定**：使用全大写字母和下划线分隔单词，如`NAMES_LIKE_THIS`。 - **注解标记**：使用`@const`注解标记来指明变量是常量。 ##### 6.3 分号在每条语句的结尾使用分号： - **分号使用**：在每条语句的末尾加上分号，即使不是必须的，也推荐这样做以减少语法错误的可能性。遵循这些编码规范可以帮助开发团队编写出易于维护、高效且高质量的JavaScript代码。通过实施统一的编码标准，可以大大简化项目的长期维护工作，并提高代码的可读性和可扩展性。

资源推荐

资源详情

资源评论

JavaScript 编程规范

（V1.0）

目录
JavaScript 编程规范....................................................................................................................... 1
（V1.0）................................................................................................................................. 1
1 介绍............................................................................................................................................. 2
1.1 为什么要有编码规范....................................................................................................... 2
2 文件组织..................................................................................................................................... 3
3 缩进排版..................................................................................................................................... 3
4 行长度......................................................................................................................................... 3
5 注释............................................................................................................................................. 3
5.1 文件注释.......................................................................................................................... 4
5.2 类注释.............................................................................................................................. 4
5.3 函数注释.......................................................................................................................... 4
5.4 常量注释.......................................................................................................................... 5
5.5 行末注释.......................................................................................................................... 5
6 语句............................................................................................................................................. 5
6.1 变量.................................................................................................................................. 5
6.2 常量.................................................................................................................................. 6
6.3 分号.................................................................................................................................. 6
7 命名规范..................................................................................................................................... 7
1 介绍 
1.1 为什么要有编码规范
编码规范对于程序员而言尤为重要，有以下几个原因： 
 一个软件的生命周期中，80%的花费在于维护
 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你
已构建的其它任何产品
为了执行规范，每个软件开发人员必须一致遵守编码规范。