javascript的基本规范.docx

javascript的基本规范

javascript的基本规范对于很多刚到公司做前端的人来说，很多基本的规范可能都不知道。在项目开发维护等工作中，我们不只要做得自己看得懂，还要别人也看得懂。而在js里也是如此。下面就由小编给大家分享下，js的一些基本规范吧。本篇主要介绍JS的命名规范、注释规范以及框架开发的一些问题。目录1.命名规范：介绍变量、函数、常量、构造函数、类的成员等等的命名规范2.注释规范：介绍单行注释、多行注释以及函数注释3.框架开发：介绍全局变量冲突、单全局变量以及命名空间1.命名规范驼峰式命名法介绍：驼峰式命名法由小(大)写字母开始，后续每个单词首字母都大写。按照第一个字母是否大写，分为：①PascalCase大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo②CamelCase小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInfo1.1变量命名方法：小驼峰式命名法。命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型;而包含name、title表示为字符串类型。示例：//好的命名方式varmaxCount=10;vartableTitle='LoginTable';//不好的命名方式varsetCount=10;vargetTitle='LoginTable';1.2函数命名方法：小驼峰式命名法。命名规范：前缀应当为动词。命名建议：可使用常见动词约定动词含义返回值can判断是否可执行某个动作(权限)函数返回一个布尔值。true：可执行;false：不可执行has判断是否含有某个值函数返回一个布尔值。true：含有此值;false：不含有此值is判断是否为某个值函数返回一个布尔值。true：为某个值;false：不为某个值get获取某个值函数返回一个非布尔值set设置某个值无返回值、返回是否设置成功或者返回链式对象load加载某些数据无返回值或者返回是否加载完成的结果示例：//是否可阅读functioncanRead(){returntrue;}//获取名称functiongetName(){returnthis.name;}1.3常量命名方法：名称全部大写。命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词。命名建议：无。示例：varMAX_COUNT=10;varURL='http://www.baidu.com';1.4构造函数介绍：在JS中，构造函数也属于函数的一种，只不过采用new运算符创建对象。命名方法：大驼峰式命名法，首字母大写。命名规范：前缀为名称。命名建议：无。示例：functionStudent(name){this.name=name;}varst=newStudent('tom');1.5类的成员类的成员包含：①公共属性和方法：跟变量和函数的命名一样。②私有属性和方法：前缀为_(下划线)，后面跟公共属性和方法一样的命名方式。示例：functionStudent(name){var_name=name;//私有成员//公共方法this.getName=function(){return_name;}//公共方式this.setName=function(value){_name=value;}}varst=newStudent('tom');st.setName('jerry');console.log(st.getName());//=>jerry：输出_name私有变量的值2.注释规范JS支持两种不同类型的注释：单行注释和多行注释。2.1单行注释说明：单行注释以两个斜线开始，以行尾结束。语法：//这是单行注释使用方式：①单独一行：//(双斜线)与注释文字之间保留一个空格。②在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。③注释代码：//(双斜线)与代码之间保留一个空格。示例：//调用了一个函数;1)单独在一行setTitle();varmaxCount=10;//设置最大量;2)在代码后面注释//setName();//3)注释代码2.2多行注释说明：以/*开头，*/结尾语法：/*注释说明*/使用方法：①若开始(/*)和结束(*/)都在一行，推荐采用单行注释。②若至少三行注释时，第一行为/*，最后行为*/，其他行以*开始，并且注释文字与*保留一个空格。示例：/**代码执行到这里后会调用setTitle()函数*setTitle()