JavaScript代码编写规范

《JavaScript代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、JavaScript代码编写规范2007-03-20Confidential-MacrowingJavaScript代码编写规范MacrowingDigitalCo.,Ltd.Tel:(86-21)51087673Fax:(86-21)51270527Email:info@macrowing.comJavaScript代码编写规范2007-03-20Confidential-Macrowing目录注释31.1变量31.2函数31.3类32命名42.1变量42.2函数52.3类53撰写规范53.1缩进53.2变量声明53.3其它54一般要求6

2、4.1变量声明6MacrowingDigitalCo.,Ltd.Tel:(86-21)51087673Fax:(86-21)51270527Email:info@macrowing.comJavaScript代码编写规范2007-03-20Confidential-Macrowing注释1.1变量如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词缩写的变量名必须在定义时给出注释说明其用途或含义，如：varsAdName;//用于表示Administrator的用户名称varsAdminName;//不用给出注释，Ad

3、min被广泛了解1.2函数每个重要函数定义之前，必须添加注释以说明此函数的主要信息，包括：函数的用途，创建者，创建时间以及函数的实现原理，如果后人修改这个函数，也要在注释中添加修改信息：包括修改内容，修改人以及修改时间等。这些信息有助于函数的使用以及函数代码的维护。例：/***@summary:在这里说明函数的用途。*@parameter:参数名称类型，说明*…………*@parameter:参数名称类型，说明*@returnValue:类型，意义说明*@create时间姓名*@remark在这里说明函数的具体实现细节*@modify时间姓名

4、*@modify时间姓名*/functionfunctionName(para1,para2){}1.3类每个类定义之前，必须添加注释以说明此类的主要信息，包括：函数的用途，创建者，创建时间等。/**@summary:在这里说明类的用途。*@created:时间姓名*@remark:在这里说明类的具体时间细节。*/functionClassName(){}MacrowingDigitalCo.,Ltd.Tel:(86-21)51087673Fax:(86-21)51270527Email:info@macrowing.comJavaScri

5、pt代码编写规范2007-03-20Confidential-Macrowing1命名1.1变量变量命名和函数命名一样采用驼峰式命名法。如果变量是某个类的私有变量，则在变量名前加一个下划线以示区别：如_privateProperty。虽然JavaScript是弱类型的脚本语言，但是还是应该像对待强类型语言一样来对待变量的类型。对于每一个变量，应统一添加前缀来指示其类型。各类型前缀如下：l整型变量：nl浮点型变量：fl布尔型变量：bl字符串变量：strlDate类型变量：datel对象引用变量：obj不同类型的HTMLElement的ID命名

6、，也应添加对应前缀：ltext输入框：txtlbutton按钮：btnlselect下拉选择框：selloption项：optlform表单：frmlframe框架：fralhidden表单项：hdnllabel标签：lblldiv标签：divlspan标签：spanlimage图像：imgl对话框对象：dlgl窗口对象：win对AjaxForm中的对象的ID命名，其前缀规定如下：lDataset：datasetlDataTable：tablelDataPilot：datapilotlPagePilot：pagepilotlTree：tre

7、elTreeNode：nodelTabset：tabsetlTab：tablMenu：menulDataLabel：lbllButton：btnlEdit：edtMacrowingDigitalCo.,Ltd.Tel:(86-21)51087673Fax:(86-21)51270527Email:info@macrowing.comJavaScript代码编写规范2007-03-20Confidential-Macrowing1.1函数函数命名采用驼峰式命名法，即首字母小写，其余单词首字母大写；并使用动词＋名词对的方式，以能够体现函数的功能

8、。如：changePassword。如果是事件响应函数，则函数名应为元素ID+”_”+事件名。如一个ID为bntSave的按钮的Click事件的响应函数，应该为btnSave_o