JavaScript代码编写规范.docVIP

JavaScript代码编写规范 目 录 注释 3 1.1 变量 3 1.2 函数 3 1.3 类 3 2 命名 4 2.1 变量 4 2.2 函数 5 2.3 类 5 3 撰写规范 5 3.1 缩进 5 3.2 变量声明 5 3.3 其它 5 4 一般要求 6 4.1 变量声明 6 注释 变量 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词写的变量名必须在定义时给出注释如： var sAdName //用于表示Administrator的名称 var sAdminName //不用给出注释，Admin被广泛了解 每个重要函数定义之前，必须添加注释以说明此函数的主要信息，包括：函数的用途，创建者，创建时间以及函数的实现原理，如果后人修改这个函数，也要在注释中添加修改信息：包括修改内容，修改人以及修改时间等。这些信息有助于函数的使用以及函数代码的维护。 例： /** * @summary : 在这里说明函数的用途。 * @parameter :参数名称 类型，说明 * ………… * @parameter :参数名称 类型，说明 * @returnValue : 类型，意义说明 * @create 时间 姓名 * @remark 在这里说明函数的具体实现细节 * @modify 时间 姓名 * @modify 时间 姓名 */ function functionName(para1, para2) { } 类 每个类定义之前，必须添加注释以说明此类的主要信息，包括：函数的用途，创建者，创建时间等。 /* * @summary : 在这里说明类的用途。 * @created :时间 姓名 * @remark : 在这里说明类的具体时间细节。 */ function ClassName() { } 命名 变量 变量命名和函数命名一样采用驼峰式命名法。 如果变量是某个类的私有变量，则在变量名前加一个下划线以示区别：如_privateProperty。 虽然JavaScript是弱类型的脚本语言，但是还是应该像对待强类型语言一样来对待变量的类型。对于每一个变量，应统一添加前缀来指示其类型。各类型前缀如下： 整型变量： 浮点型变量：f 字符串变量： Date类型变量：date 对象引用变量：obj text输入框：txt button按钮：btn select下拉选择框：sel option项：opt form表单：frm frame框架：fra hidden表单项：hdn div标：div span标：span 对话框对象：dlg 窗口对象：win Dataset：dataset DataTable：table DataPilot：datapilot PagePilot：pagepilot Tree：tree TreeNode：node Tabset：tabset Tab：tab Menu：menu DataLabel：lbl Button：btn Edit：edt 函数 函数命名采用驼峰式命名法，即首字母小写，其余单词首字母大写；并使用动词＋名词对的方式，能够体现函数的功能 如果是事件响应函数，则函数名应为元素ID+”_”+事件名。如一个ID为bntSave的按钮的Click事件的响应函数，应该为btnSave_onClick。 如果函数是某个类的私有函数，则在函数名前加两个连续的下划线以示区别：如__privateFunction。 类 类命名采用Pascal命名法，即首字母大写，后续单词首词语大写，其余字母小写的命名方式。如：ClassName。 撰写规范 缩进 最外层的语句不缩进，采用左对齐顶格方式书写。如果在HTML中内嵌脚本，则script标签也要左对齐。这样可保证快速地找到HTML中的脚本。 在function、for、while、do、if、else、switch、case等语句中的子语句，必须采用缩进，以保持良好的代码外观，方便代码的阅读。 变量声明 所有变量，不管全局变量，还是局部变量，都要在使用前使用var语句进行声明。 其它 在“{”之前一定要换行。另外在for、while、do、if、else等语句中的子语句，就算只有一句，也建议使用大括号括起来。 例： script type=”text/javascript” function functionName() { var name; for(var i=0; i4; i++) { //… } if() { // 就算只有一句也要加大括号。 } } /script 一般要求 变量声明 JavaScript代码编写规范 2007-03-18 Confidential-Macrow