javascript编程规范-修订版

《javascript编程规范-修订版》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、JAVASCRIPT规恋文件状态：文件标识：[]草稿当前版本：[]正式发布作者：[]正在修改完成日期：二零一一年-一月修改历史编号修订人修订内容简述修订日期修订前版本号修订后版本号1命名规范1.1基本原则11.2Prototype/Method命名规范11.2.1原型Prototype11.2.2方法Method/函数Function11.3字段命名规范21.3.1常量21.3.2变量21.3.3集合21.3.4特殊值21.4异常31.5文件命名规范31.6命名约定表3代码组织与风格2.1整体风格42.1.1缩

2、排42.2文件布局5注释格式规范4编程规范54.1原型54.1.1toStringf）54.2方法64.2.1基本原则64.2.2参数64.3表达式与语句74.3.1基本原则74.3.2控制语句74.3.3循环语句74.4错误处理74.4.1基本原则74.4.2可预见错误84.4.3不可预见错误84.5测试与BUG跟踪84.5.1基本原则84.5.2跟踪和缺陷处理91命名规范1-1基本原则规范的命名能使程序更易阅读，从而更易丁•理解。它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。>使用可以准

3、确说明变量/函数/原型(prototype)的完整英文描述符。例如，firstName,listAHUsers或CorporateCustomer等，严禁使用汉语拼咅、不相关单词及汉字进行命名。>采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是原型(prototype)命名时任意单词的首字母大写。>尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等，如实现(implement)可缩写成imp],经理(manager)可缩写成mgr等，严禁滥用缩写。>避免使用长名字(最好不超过25个字母)。>

4、避免使用相似或者仅在大小写上有区别的名字。>避免使用数字，但可用2代替to,用4代替for等，女山go2Jspo此外，若元素id包含数字则除外1.2Prototype/Method命名规范1.2.1原型Prototype所有单词首字母大写。使用能确切反应该原型含义、功能等的词。一般采用名词。1.2.2方法Method/函数Function方法的命名应采用完整的、能够清楚表达该方法功能的英文描述符，首字母小写，其他单词的首字母大写。方法名称的第一个单词常常采用一个有强烈动作色彩的动词。取值类使用get前缀，设值类

5、使用set前缀，判断类使用is(has)前缀。如下例所示：getName()setSarryOisLogon()方法参数建议顺序：（被操作者，操作内容，操作标志，其他……）。如下例所示:functionreplace(sourceStr,〃源字串oldStr,〃被替换字串}newStr){〃替换为字串1.3字段命名规范1.3.1常量采用完整的英文大写单词，在词与词之I'可用下划线连接，女口：DEFAULT_VALUE1.3.2变量对不易淸楚识别出其类型的变量应使用类型缩写作其前缀，如字符串使用sirXXX,bo

6、olean使用isXXX,hasXXX等等。除第一个单词外其余单词首字母大写。对私有实例变量可使用一前缀，但在其存取方法中则应该将其前缀去掉。1.3.3集合一个集合，例如数组或xml节点集合，应采用复数命名來表示变量中存放的是一组对象。命名应采用完整的英文描述符，名字中所有非首单词的第一个字母应大写，适当使用集合缩写前缀。如下例所示：集合变量命名示例varrowNodes=xmlDom.selectNodes（"/*/data/:row''）;vararyUsers=[];//用户列表1.3.4特殊值我们在程序

7、里经常会用到一些量，它是有特定的含义的。例如，现在我们写一个薪金统汁程序，公司员工有50人，我们在程序里就会用50这个数去进行各种各样的运算。在这里,50就是“特殊值”。当别的程序员在程序里看到50这个数，将很难知道它的含义，造成理解上的困难。在程序里出现“特殊值”会降低程序的可读性、可维护性和可扩展性，故规定不得出现此类“特殊值”。避免的方法是把“特殊值”定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，且单词之间使用下划线。例如上面50这个数，我们可以定义一个名为NUM_OF_EMP

8、LOYEES的常量。这样，别的程序员在读程序的时候就可以很容易的理解了。1.4异常通常情况下不需要自定义异常原型，仅使用内建error对象。开常原型由表示该并常类型的单词和Exception组成，女UResponseException。异常实例一般使用e、ex等，在多个异常时使用该异常名或简写加E,Ex等组成，例如：SQLEx^ActionExo1.5文件命名规范外部js文件一律小写命