浅谈JavaScript编程语言的编码规范
- 格式:docx
- 大小:25.03 KB
- 文档页数:6
JavaScript 编码规范2016 年 02 月 18 日规范基本信息表: 规范简称: 规范版本号: 规范修订日期: 本规范位置: 先前版本位置: 规范制定组织: 规范制定牵头人: 规范校订人: 王军锋 JavaScript编码规范 1.0 2016-02-18第1页JavaScript 编码规范1 概要 1.1 规范摘要 本规范主要目的是定义基于JavaScript编码的总体规范,确保编码的规范性,提高程序的可维护性。
通过遵循共同的编码规范,程序开发人员可以保持代码一贯的风格,提高代码编写的可读性和使用的一贯 性。
1.2 背景1.3 现状1.4 相关工作说明1.5 规范声明2 适用范围3 引言 3.1 词汇表 3.1.1 首选术语3.1.2 相关术语3.2 格式约定3.3 文件引用 《ECMAScript-262标准》。
第2页《JavaScript权威指南V5》。
《JavaScript高级程序设计V2》。
《JavaScript高性能》。
《Google JavaScript开发规范》。
4 需求5 规范正文 5.1 排版规范 5.1.1 文件结构 JavaScript文件按如下顺序组织各元素:序号 1 2 元素 版权、版本声明 总体注释 说明 以注释的方式进行声明 在注释中总体介绍该文件实现的功能; 对如何使用这些功能给出指导性意见; 给出使用示例; 指出注意事项; 罗列依赖的其它JavaScript文件; 注明:第一作者、第二作者…。
3 程序内容5.1.2 缩进排版 以4个空格为一个缩进单元,避免使用Tab制表符。
【示例】:function getUser(id) { if ( !id ) { throw new Error(“”); } }5.1.3 行排版 一行的字符不建议超过120个字符,一行过多的字符会影响查看程序的效率。
如果一段描述不能放在一行中,依据下列规则将其拆分成多行: 1) 从分隔符(比如空格)后换行; 2) 在运算符之前换行;第3页3) 不拆分完整的单词; 4) 换行后如果需要缩进则不应缩进超过行中。
js代码规范JavaScript代码规范(1000字)JavaScript是一种广泛使用的脚本语言,具有灵活性和强大的功能。
为了使代码可读性更好、易于维护和共享,遵循一定的代码规范是非常重要的。
下面是一些常用的JavaScript代码规范。
1. 缩进:使用4个空格作为缩进。
不要使用制表符。
2. 空格:在运算符和操作数之间使用空格,使代码更易读。
3. 大括号:在if、for、while等语句中始终使用大括号。
即使语句只有一行,也应使用大括号。
这样可以减少错误,并提高代码的可读性。
4. 变量命名:使用驼峰命名法(camel case)命名变量和函数。
变量名应具有描述性,并遵循一致的命名约定。
5. 常量命名:使用全大写字母和下划线命名常量。
示例:MAX_LENGTH。
6. 注释:使用注释来解释代码的目的和用途。
对于复杂的代码块或特殊的算法,添加详细的注释是非常重要的。
7. 函数:函数应该具有描述性的名字,并且只完成一个任务。
函数应该尽量保持简短,并避免嵌套过深。
8. 字符串:使用单引号或双引号括起字符串,并保持一致。
示例:var name = 'John';。
9. 变量声明:始终使用var关键字声明变量。
这样可以提高代码的可读性,并避免变量泄漏到全局作用域。
10. 分号:在每条语句的末尾添加分号。
这样可以避免出现一些难以排查的错误。
11. 引号:避免在对象字面量中使用引号。
示例:var person = {name: 'John', age: 30};。
12. 布尔类型:避免使用布尔类型的构造函数。
示例:var isValid = true;。
13. 比较运算符:使用全等(===)和不全等(!==)运算符进行比较。
不要使用双等号(==)进行比较。
14. 避免全局变量:避免在全局作用域中定义变量。
将变量封装在函数内部,以减少变量冲突和增加代码的可维护性。
15. 异常处理:在可能引发错误的代码块中使用try-catch语句来处理异常。
JavaScript编码规范1.说明本规范适用于汉捷机械部件(常州)有限公司信息技术部,为公司的系统开发提供标准及约定,有助于软件开发人员快速掌握JS的编码规则,能够快速的融入到团队开发中,使用团队开发的效率大大提高。
2.命名规范3.1基础命名规范1. 所有变量必须是有意义的英文,禁止使用拼音,如错误的写法:paifuwu();fucusTa();2. 变量允许使用公认英文缩写,如:showMsg();getXML();3. 类命名必须是驼峰式,如:var foo = new MyClass();4. 常量必须所有单词大写,并且每个单词间加下划线,如:var BITMAP_FLAG = 777;5. 枚举类型时,枚举的命名必须有意义,枚举和枚举成员必须以驼峰式或大写:var NodeTypes = {Element : 1,DOCUMENT: 2}6. 常量和枚举必须在最前端定义,脚本合并时注意,必须把常量与枚举定义的文件放在文件列表的第一位7. 变量内的简写单词不能全大写,如:XmlDocument strHtml8. 函数开头必须是有意义的动词或动词短语,如:getSize()setSize()isTrue()9. 私有类的变量属性成员必须使用混合式命名,并前面下下划线,如:_foo_height_getSize()10. 临时的全局变量放到一个全局的哈希表里,方便变量回收11. 大括号前面不能有换行符://正确的写法:if (true) {}//错误的写法:if (true){}3.2高级命名规范1. 前面加“is”的变量名应该为布尔值,亦可使用“can”“has”“should”2. 前面加”str”的变量名应该为字符串3. 前面加“arr”的变量名应该为数组4. 前面加“num”或“count”的变量名应该为数字5. “o”作为局部变量或参数,表示为Object6. “e”作为局部变量或参数,表示为Event7. “el”作为局部变量或参数,表示为Element8. 能缩写的单词尽量缩写9. 避免产生令人误解的布尔值:isNotNumber isNan10. 处理错误的变量,必须在后面跟着“Error”11. 尽量做有意义的代码折行,不要让一行代码过长。
js编码规范JavaScript编码规范是为了提高代码的可读性、可维护性和可扩展性而制定的一系列规定。
下面是一个简洁的JavaScript编码规范,共计1000个字。
1. 缩进使用4个空格,不使用制表符。
2. 在函数和控制语句之间增加空行,以提高可读性。
3. 每行代码的长度不超过80个字符,超过的部分需要换行。
4. 命名使用驼峰命名法,避免使用下划线命名。
5. 变量和函数命名使用有意义的名词或动词短语。
6. 避免使用全局变量,将变量声明在函数内,或者使用模块化开发。
7. 使用const和let关键字声明变量,避免使用var。
8. 将常量定义为全大写的字母组合,使用下划线分隔。
9. 函数和方法之间使用空格进行分隔。
10. 使用单引号或双引号包裹字符串,统一在项目中使用一种引号。
11. 使用===和!==进行严格相等比较,避免使用==和!=进行比较。
12. 避免使用eval函数和with语句,它们可能导致代码执行的不可控性。
13. 在比较运算符和逻辑运算符周围增加空格,提高代码可读性。
14. 使用{}包裹代码块,不省略{}对于HTML和CSS的相关规范,可以参考对应的规范文件。
15. 在函数和方法之间使用空行分隔,提高可读性。
16. 使用箭头函数或者函数表达式,避免使用匿名函数。
17. 在if语句和for循环等控制语句中,使用括号包裹条件,提高可读性。
18. 在数组或对象的声明中,每行只声明一个元素,增加可读性。
19. 避免使用eval函数和with语句,它们可能导致代码执行的不可控性。
20. 使用ES6的模块化规范,避免使用全局变量,改用导入和导出模块。
以上是一个简洁的JavaScript编码规范,它能够帮助开发人员编写出易于阅读、维护和扩展的JavaScript代码。
然而,在实际开发过程中,根据不同的项目和团队需求,具体的编码规范可能会有所不同,因此可以根据实际情况进行调整和补充。
最后,严格遵守编码规范,可以提高团队合作效率,降低代码出错和维护的成本。
浅谈JavaScript编程语言的编码规范简介:JavaScript编程语言作为最流行的客户端脚本语言,早已被众多Web 开发人员所熟悉。
随着Web2.0时代的到来和Ajax技术的广泛应用,JavaScript也逐渐吸引着更多的视线。
工作中要求越多的是对JavaScript语言的深入学习,灵活运用,和对编码质量的保证。
对于熟悉C/C++或Java语言的工程师来说,JavaScript显得灵活,简单易懂,对代码的格式的要求也相对松散。
很容易学习,并运用到自己的代码中。
也正因为这样,JavaScript的编码规范也往往被轻视,开发过程中修修补补,最终也就演变成为后续维护人员的恶梦。
软件存在的长期价值直接与编码的质量成比例。
编码规范能帮助我们降低编程中不必要的麻烦。
而JavaScript代码是直接发送给客户浏览器的,直接与客户见面,编码的质量更应该受到关注。
本文浅谈JavaScript编程中关于编码规范的问题,分析其中缘由。
希望引起更多Web开发人员对JavaScript编码规范问题的关注和对软件产品质量问题的重视。
前言提及C/C++和Java编码规范,相信许多工程师并不生疏。
但说到JavaScript 语言的编码规范,也许您会忍俊不禁。
JavaScript不是语法很灵活吗?变量随时用随时可以声明;语句结束符可以不要;字符串和数字也可以相加;参数多一个少一个也不会报错。
没错,当您从C/C++和Java严格的语法规定之下,转向JavaScript语言,会觉得自由了很多,轻松了很多。
语法松散是JavaScript 重要的特征。
它灵活易懂,给开发人员带来了很多方便,但如果编写过程中不注意,代码的调试成本和维护成本则会无形地增加。
JavaScript编码会随应被直接发送到客户端的浏览器,代码规范不只是代码质量的保证,也影响到产品的长期信誉。
希望JavaScript编程语言的规范问题也能同样引起更多朋友的关注。
JavaScript 编码规范一、命名规范1.允许名称中包含字母,数字,下划线'_'和‘$’,区分大小写2.变量(函数)的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解3.命名中若使用特殊约定或缩写,则要有注释说明4.除了在xpcom组件中,尽量不要使用“_”作为变量(函数)名的第一个字符。
它有时用来标识私有变量(函数),但实际上javascript并没有提供私有变量的功能。
如果私有变量很重要,可以使用私有成员的形式,应避免使用这种容易让人误解的命名习惯5.用正确的反义词组命名具有互斥意义的变量或相反动作的函数等注意:没有关系的变量不要使用***1,***2,***3,***4没有测试意义的变量(函数)不要用test开头二、声明1.变量声明1)所有变量必须在使用前定义,尽管javascrip并不强制要求这样做,但是这样做可以增加程序的可读性,且容易发现那些没有声明的变量(它们会被编译成全局变量)2)尽量减少全局变量的使用,不要让局部变量覆盖全局变量3)在函数的开始应先用 var 关键字声明函数中要使用的局部变量,每个变量单独占一行,注释变量的功能及代表的含义。
2.函数声明1)所有函数也必须在调用前进行声明2)内部函数应在 var 声明内部变量的语句之后声明,可以清晰地表明内部变量和内部函数的作用域。
三、语句1.一行最多有一个语句,语句后边要有“;”注:如果一个赋值语句是用函数和对象来赋值,可能需要跨多行,一定切记要在赋值语句末加上分号。
这是因为 JavaScript 中,所有表达式都可以当语句,遇换行符时会解析为表达式的结束,此时不规范的换行和分号的丢失,可能引入新的错误。
2.对于复合语句,if, for, while, do, switch, try … catch 等代码体,函数定义的函数体,对象的定义等都需要放在花括号'{}'里面。
javascript用的编码格式Javascript是一种高级的脚本语言,广泛应用于Web开发中,并被用于开发各种动态网页和应用。
在开发Javascript代码时,编码格式同样非常重要。
下面就让我们来了解一下Javascript用的编码格式。
1. 文件编码格式:Javascript代码文件应采用UTF-8编码格式,因为这种编码格式可以支持大部分字符集,并且可以跨平台使用,确保代码的可移植性。
2. 缩进:在Javascript代码中,缩进对代码的可读性和可维护性非常重要。
缩进可以使代码清晰、易于阅读,并使代码逐层嵌套更加清晰。
一般情况下,常用的缩进量是4个空格或1个制表符。
3. 命名规范:Javascript代码中的变量名、函数名、对象名等应遵循一定的命名规范。
一般情况下,Javascript中的命名应使用驼峰式命名法,即首字母小写,后面几个单词首字母大写,这样可以使代码更加清晰易懂。
4. 语句结尾:在Javascript代码中,语句的结尾应该使用分号来结束。
这种做法可以使代码更加清晰、易于维护,并防止出现一些不必要的错误。
5. 注释:在Javascript代码中加入注释可以提高代码的可读性和可维护性。
注释可以对代码进行解释说明,使代码更加清晰易懂。
一般情况下,注释应该放在代码的上方,以便开发人员快速理解代码的含义。
6. 规范性:为了保证Javascript代码的规范性,我们应该在代码中避免出现重复的变量、函数和对象等。
我们还应该尽量避免使用全局变量,而是使用局部变量,这将使代码更加安全和可读。
综上所述,编写高质量的Javascript代码需要注意编码格式、缩进、命名规范、语句结尾、注释及规范性等多个方面。
遵循这些规则可以让Javascript代码更易于理解,更加清晰易懂,也更容易被其他开发者维护和修改。
JavaScript的代码规范作为一门常用且灵活的编程语言,JavaScript能够为网页开发带来很多便利。
然而,由于其灵活性,JavaScript代码往往容易出现混乱和难以维护的问题。
为了提高代码的可读性和可维护性,制定并遵守一套良好的JavaScript代码规范是至关重要的。
一、命名规范1. 变量名、函数名和方法名应该使用驼峰命名法,即首字母小写,后续单词首字母大写。
例如:firstName。
2. 常量名应该全部大写,多个单词之间用下划线(_)分隔。
例如:MAX_COUNT。
3. 类名应该使用帕斯卡命名法,即首字母大写,后续单词首字母大写。
例如:Person。
二、缩进和空格1. 使用两个空格进行缩进,并确保在代码块之间的一致性。
2. 操作符前后应该加上空格,例如:var x = y + z;。
3. 在大括号({})前使用一个空格,例如:if (x > 0) {。
4. 在逗号(,)后面使用一个空格,例如:var fruits = ['apple', 'banana', 'orange'];。
三、注释规范1. 使用注释来解释代码的意图和功能,提高代码的可读性。
2. 使用单行注释(//)或多行注释(/* */)来注释代码。
3. 在函数、类和方法的上方使用多行注释来说明其功能和输入输出。
四、代码格式1. 所有语句结尾都应该加上分号(;),即使在可选的情况下也应该如此。
2. 在逻辑行结束后换行,不要过长的一行代码。
3. 在操作符之间使用空格,但在逗号后不需要加上空格。
4. 使用合理的缩进,保持代码块的整洁和可读性。
五、变量和常量声明1. 使用var来声明变量,避免使用全局变量。
2. 在函数或代码块的顶部声明变量,避免变量声明的提升带来的问题。
3. 声明变量时给其赋初值,避免出现undefined的情况。
4. 使用const或let来声明常量或块级作用域的变量,以提高代码的可维护性。
最全的Javascript编码规范(推荐)Javascript程序应该尽量放在.js的⽂件中,需要调⽤的时候在页⾯中以<script src="filename.js">的形式包含进来。
Javascript 代码若不是该页⾯专⽤的,则应尽量避免在页⾯中直接编写Javascript代码。
a) 缩进在同⼀系统中应采⽤同⼀种缩进标准,本⽂提倡缩进⼤⼩为4个空格。
各编译器对Tab键所代替的空⽩⼤⼩定义不同。
建议在设置开发环境时,将编辑器⾥的Tab快捷键重新设置成4个空格。
多数编译器提供了此功能。
否则建议按4次空格来进⾏缩进。
b) 换⾏在以下位置必须换⾏:每个独⽴语句结束后;if、else、catch、finally、while等关键字前;运算符处换⾏时,运算符必须在新⾏的⾏⾸。
对于因为单⾏长度超过限制时产⽣的换⾏,参考⾏长度中的策略进⾏分隔。
每⾏代码应⼩于80个字符。
若代码较长应尽量换⾏,换⾏应选择在操作符和标点符号之后,最好是在分号“;”或逗号“,”之后。
下⼀⾏代码相对上⼀⾏缩进4个空格。
这样可以有效防⽌复制粘贴引起的代码缺失等错误并增强可读性。
按⼀定长度截断字符串,并使⽤+运算符进⾏连接。
分隔字符串尽量按语义进⾏,如不要在⼀个完整的名词中间断开。
特别的,对于HTML⽚段的拼接,通过缩进,保持和HTML相同的结构:也可使⽤数组来进⾏拼接,相对+运算更容易调整缩进:三元运算符由3部分组成,因此其换⾏应当根据每个部分的长度不同,形成3种不同的情况:不得出现以下情况:当因为较复杂的逻辑条件组合导致80个字符⽆法满⾜需求时,应当将每个条件独⽴⼀⾏,逻辑运算符放置在⾏⾸进⾏分隔,或将部分逻辑按逻辑组合进⾏分隔。
最终将右括号)与左⼤括号{放在独⽴⼀⾏,保证与if内语句块能容易视觉辨识。
如:如果对象属性较多导致每个属性⼀⾏占⽤空间过⼤,可以按语义或逻辑进⾏分组的组织,如:通过5个⼀组的分组,将每⼀⾏控制在合理的范围内,并且按逻辑进⾏了切分。
前言:JavaScript编程规范目的1. 统一编程风格2. 提高代码的可阅读性3. 减少错误产生4. 减少性能漏洞5. 提高代码可靠性6. 减少错误的编码设计7. 作为代码检查的依据8. 建立可维护的JavaScript语言编程规范1.JavaScript文件1.1 文件引用JavaScript 代码不应该被包含在HTML 文件中,除非这是段特定只属于此部分的代码。
在HTML 中的JavaScript代码会明显增加文件大小,而且也不能对其进行缓存和压缩。
filename.js 应尽量放到body 的后面。
这样可以减少因为载入脚本而造成其他页面内容载入也被延迟的问题。
禁止使用language 属性,必须使用type 属性。
示例:<script type="text/javascript"src="filename.js"></script>1.2 编码格式分离于页面之外的js文件必须采用UTF-8无BOM格式编码,否则极其容易出现不可预知的乱码问题。
维护已存在的js脚本文件必须把编码格式转换成规范要求的UTF-8无BOM格式。
2.排版规则2.1 缩进每一级缩进采用4个空白符。
不要使用Tab作为缩进方式,除非在编辑器里设置了自动将一个Tab转换为4个空白符。
2.2 空白2.2.1 空行适当的空行可以大大提高代码的可阅读性,可以使代码逻辑更清晰易懂。
相对独立的程序块之间、变量说明之后必须加空行。
示例:if (a > b){doStart();}//此处是空行return;源程序中关系较为紧密的代码应尽可能相邻,便于程序阅读和查找。
示例:矩形的长与宽关系较密切,放在一起。
rect.length = 10;rect.width = 5;2.2.2 空格在表达式中适当使用空格,会给代码的阅读带来方便。
关键字的后面如有括号,则最好在关键字和左括号'('之间留空白,如 for, if, while 等。
浅谈JavaScript编程语言的编码规范简介: JavaScript 编程语言作为最流行的客户端脚本语言,早已被众多Web 开发人员所熟悉。
随着Web2.0 时代的到来和Ajax 技术的广泛应用,JavaScript 也逐渐吸引着更多的视线。
工作中要求越多的是对JavaScript 语言的深入学习,灵活运用,和对编码质量的保证。
对于熟悉C/C++ 或Java 语言的工程师来说,JavaScript 显得灵活,简单易懂,对代码的格式的要求也相对松散。
很容易学习,并运用到自己的代码中。
也正因为这样,JavaScript 的编码规范也往往被轻视,开发过程中修修补补,最终也就演变成为后续维护人员的恶梦。
软件存在的长期价值直接与编码的质量成比例。
编码规范能帮助我们降低编程中不必要的麻烦。
而JavaScript 代码是直接发送给客户浏览器的,直接与客户见面,编码的质量更应该受到关注。
本文浅谈JavaScript 编程中关于编码规范的问题,分析其中缘由。
希望引起更多Web 开发人员对JavaScript 编码规范问题的关注和对软件产品质量问题的重视。
前言提及C/C++ 和Java 编码规范,相信许多工程师并不生疏。
但说到JavaScript 语言的编码规范,也许您会忍俊不禁。
JavaScript 不是语法很灵活吗?变量随时用随时可以声明;语句结束符可以不要;字符串和数字也可以相加;参数多一个少一个也不会报错。
没错,当您从C/C++ 和Java 严格的语法规定之下,转向JavaScript 语言,会觉得自由了很多,轻松了很多。
语法松散是JavaScript 重要的特征。
它灵活易懂,给开发人员带来了很多方便,但如果编写过程中不注意,代码的调试成本和维护成本则会无形地增加。
JavaScript 编码会随应被直接发送到客户端的浏览器,代码规范不只是代码质量的保证,也影响到产品的长期信誉。
希望JavaScript 编程语言的规范问题也能同样引起更多朋友的关注。
JavaScript 编码规范建议本文就JavaScript 编码过程中涉及的排版、命名、声明、作用域、及一些特殊符号的使用等方面,根据个人在学习工作中的总结,给出自己的一些建议,并分析其中缘由,以供参考。
JavaScript 文件引用JavaScript 程序应该尽量放在 .js 的文件中,需要调用的时候在HTML 中以<script src="filename.js"> 的形式包含进来。
JavaScript 代码若不是该HTML 文件所专用的,则应尽量避免在HTML 文件中直接编写JavaScript 代码。
因为这样会大大增加HTML 文件的大小,无益于代码的压缩和缓存的使用。
另外,<script src="filename.js"> 标签应尽量放在文件的后面。
这样会降低因加载JavaScript 代码而影响页面中其它组件的加载时间。
代码排版行长度每行代码应小于80 个字符。
如果代码较长,应尽量选择换行,下一行代码应缩进8 个空格。
这样可以使代码排版整齐,减轻阅读代码的疲劳感。
换行缩进8 个空格可以和代码段的缩进4 个空格区分开,以增强代码的可阅读性。
行结束JavaScript 语句应该以分号结束。
但大多数浏览器允许不写分号,只要在本应是分号的地方有一个换行符就行。
但是如果代码行较长需要换行的时候,有哪些注意事项呢?换行应选择在操作符和标点符号之后,最好是在逗号','之后,而不要在变量名、字符串、数字、或')' ']' '++' '--'等符号之后换行。
这样可以有效的防止拷贝、粘贴而引起的错误,并可有效地增强代码的可阅读性。
请见清单1,代码的输出符合我们的期望。
但就写法而言,对valueB 的赋值语句是在变量valueA 之后进行的换行,这很容易被误解为valueB=ValueA,给阅读造成障碍。
而对valueC 的复制语句是在'+'之后进行的换行,就容易理解的多。
这也是本文所提倡的换行方式。
清单1. 行结束的位置代码:<script language="javascript">var valueA = 1;var valueB = valueA ///bad+1;var valueC = valueB + ///goodvalueA;alert (valueB); //output: valueB=2alert (valueC);//output: valueC=3</script>缩进关于缩进的问题,不只是JavaScript,几乎所有的语言编写的时候,都会提及缩进的问题。
缩进几乎是代码编写规范的第一课,是代码可阅读性判断的直接因素。
代码缩进的好处是不言而喻的,但是对于如何缩进,则没有标准而言。
最受欢迎的是方便使用TAB 键缩进,也有些喜欢用2 个、4 个、8 个空格进行缩进。
这样缩进风格不一,也同样给代码的阅读带来障碍。
本文提倡用4个空格来进行缩进,并在同一产品中采用同一种缩进标准。
不支持用TAB 键进行缩进。
这是因为直到现在还没有统一的标准来定义TAB 键所代替的空白大小,有些编辑器解析为4 个空格大小,有些则解析为8 个。
因而用不同的编辑器查看代码,可能造成格式混乱。
当然TAB 简单易用,为解决这个问题,建议在设置开发环境时,将编辑器里的TAB 快捷键重新设置为4 个空格。
据了解Eclipse, Vi, Nodepad++,Editplus, UltraEdit 等流行的编辑器,均提供了此功能。
注释代码中的注释很重要,自然也是毋庸置疑的。
通常我们会强调代码中注释数量的多少,而轻视了对注释质量的提高。
编码是及时添加注释,会给后续代码的维护人员带来很大的便利。
但是如果注释不注意更新,或者由于拷贝、粘贴引起的错误的注释,则会误导阅读人员,反而给阅读带来障碍。
除了注释要及时更新外,我们还应对注释的内容要特别关注。
注释要尽量简单、清晰明了,避免使用含混晦涩的语言,同时着重注释的意义,对不太直观的部分进行注解。
请见清单2。
清单2. 有意义的注释代码:<script language="javascript">//following section is used to initialize golbal variables (good)var valueA = 0; //initialize valueA to be sero (bad)var valueB = 1;...//call f1 function after waiting for 50 seconds. (good)setTimeout (f1,50000); //set timeout to be 20s (copy error)...</script>这样的注释方式在JavaScript 代码中经常见到。
"initialize valueA to be sero" 这样的注释有什么用呢?难道阅读程序的工程师从"var valueA = 0;"复制语句中看不出来么?"set timeout to be 20s"这条注释,不只是因拷贝、粘贴引起的时间大小的错误,同时也误导了程序员对这条语句的理解。
setTimeout () 函数的作用并非是设置函数执行的超时时间,而是等待一定时间后执行所调用的函数,害人匪浅呀。
这样的注释内容宁可删掉。
此外,JavaScript 的注释有两种"//" 和"/* .... */",建议"//"用作代码行注释,"/* .... */"形式用作对整个代码段的注销,或较正式的声明中,如函数参数、功能、文件功能等的描述中。
标识符命名JavaScript 中的标识符的命名规则:∙以字母、下划线'_'或美元符号'$'开头∙允许名称中包含字母,数字,下划线'_'和美元符号'$'∙区分大小写变量、参数、成员变量、函数等名称均以小写字母开头,构造器的名称以大写字母开头。
下划线'_'开头的变量一般习惯于标识私有/局部成员。
而美元符号'$'开头的变量习惯于标识系统相关,比如系统进程等。
应避免用下划线'_'或美元符号'$'来命名标识符。
尽可能地降低代码的阅读负担。
声明变量的声明尽管JavaScript 语言并不要求在变量使用前先对变量进行声明。
但我们还是应该养成这个好习惯。
这样可以比较容易的检测出那些未经声明的变量,避免其变为隐藏的全局变量,造成隐患。
在函数的开始应先用var 关键字声明函数中要使用的局部变量,注释变量的功能及代表的含义,且应以字母顺序排序。
每个变量单独占一行,以便添加注释。
这是因为JavaScript 中只有函数的{} 表明作用域,用var 关键字声明的局部变量只在函数内有效,而未经var 声明的变量则被视为全局变量。
我们来看下清单3。
清单3. 局部变量声明代码:<script language="javascript">var valueA = "a";var valueB = "b";function f1 () {var valueA = "c";alert ("valueA="+valueA); //output: valueA=cvalueB = "d";alert ("valueB="+valueB); //output: valueB=d}f1 ();alert ("valueA="+valueA); //output: valueA=aalert ("valueB="+valueB); //output: valueB=d</script>从上例的输出惊奇地发现,用var 声明过的变量valueA 和没有声明的变量valueB 是有区别的。
特别需要注意的是,在函数内部用var 声明的变量为局部变量,这样可以有效地避免因局部变量和全局变量同名而产生的错误。
函数的声明函数也应在调用前进行声明,内部函数应在var 声明内部变量的语句之后声明,可以清晰地表明内部变量和内部函数的作用域。