javascript的基本规范.doc

javascript的基本规范 对于很多刚到公司做前端的人来说，很多基本的规范可能都不知道。在项目开发维护等工作中，我们不只要做得自己看得懂，还要别人也看得懂。而在js里也是如此。下面就由小编给大家分享下，js的一些基本规范吧。 目录 1. 命名规范：介绍变量、函数、常量、构造函数、类的成员等等的命名规范 2. 注释规范：介绍单行注释、多行注释以及函数注释 3. 框架开发：介绍全局变量冲突、单全局变量以及命名空间 1. 命名规范 驼峰式命名法介绍： 驼峰式命名法由小(大)写字母开始，后续每个单词首字母都大写。 按照第一个字母是否大写，分为： ① Pascal Case 大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo ② Camel Case 小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInfo 变量 命名方法：小驼峰式命名法。 命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数) 命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型;而包含name、title表示为字符串类型。 示例： // 好的命名方式 var maxCount = 10; var tableTitle = LoginTable; // 不好的命名方式 var setCount = 10; var getTitle = LoginTable; 函数 命名方法：小驼峰式命名法。 命名规范：前缀应当为动词。 命名建议：可使用常见动词约定 动词　　 含义 返回值 can 判断是否可执行某个动作(权限) 函数返回一个布尔值。true：可执行;false：不可执行 has 判断是否含有某个值 函数返回一个布尔值。true：含有此值;false：不含有此值 is 判断是否为某个值 函数返回一个布尔值。true：为某个值;false：不为某个值 get 获取某个值 函数返回一个非布尔值 set 设置某个值 无返回值、返回是否设置成功或者返回链式对象 load 加载某些数据 无返回值或者返回是否加载完成的结果 示例： // 是否可阅读 function canRead() { return true; } // 获取名称 function getName() { return ; } 常量 命名方法：名称全部大写。 命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词。 命名建议：无。 示例： var MAX_COUNT = 10; var URL = http://; 构造函数 介绍：在JS中，构造函数也属于函数的一种，只不过采用new 运算符创建对象。 命名方法：大驼峰式命名法，首字母大写。 命名规范：前缀为名称。 命名建议：无。 示例： function Student(name) { = name; } var st = new Student(tom); 类的成员 类的成员包含： ① 公共属性和方法：跟变量和函数的命名一样。 ② 私有属性和方法：前缀为_(下划线)，后面跟公共属性和方法一样的命名方式。 示例： function Student(name) { var _name = name; // 私有成员 // 公共方法 = function () { return _name; } // 公共方式 = function (value) { _name = value; } } var st = new Student(tom); (jerry); (()); // = jerry：输出_name私有变量的值 2. 注释规范 JS支持两种不同类型的注释：单行注释和多行注释。 单行注释 说明：单行注释以两个斜线开始，以行尾结束。 语法：// 这是单行注释 使用方式： ① 单独一行：//(双斜线)与注释文字之间保留一个空格。