js的基本规范文档格式.docx
《js的基本规范文档格式.docx》由会员分享，可在线阅读，更多相关《js的基本规范文档格式.docx（10页珍藏版）》请在冰点文库上搜索。
2.1总体命名规范2.1.1命名基本规范
1）.变量名称必须为小写字母。
2）.类的命名使用骆驼命名规则，例如：
account,eventhandler
3）.常量必须在对象（类）或者枚举变量的前部声明。
枚举变量的命名必须要有实际的意义，并且其成员必须使用骆驼命名规则或使用大写：
varnodetypes={element:
1,document:
2}
4）.简写单词不能使用大写名称作为变量名：
getinnerhtml（）,getxml（）,xmldocument
5）.方法的命令必须为动词或者是动词短语：
obj.getsomeValue（）6）.公有类的命名必须使用混合名称（mixedcase）命名。
7）.css变量的命名必须使用其对应的相同的公共类变量。
8）.私有类的变量属性成员必须使用混合名称（mixedcase）命名，并前面下下划线（_）。
例如：
varmyclass=function（）{var_buffer;
this.dosomething=function（）{};
}
9）.变量如果设置为私有，则前面必须添加下划线。
this._someprivateVariable=statement;
10）.通用的变量必须使用与其名字一致的类型名称：
settopic（topic）//变量topic为topic类型的变量11）.所有的变量名必须使用英文名称。
12）.变量如有较广的作用域（largescope），必须使用全局变量；
此时可以设计成一个类的成员。
相对的如作用域较小或为私有变量则使用简洁的单词命名。
13）.如果变量有其隐含的返回值，则避免使用其相似的方法：
gethandler（）;
//避免使用geteventhandler（）
14）.公有变量必须清楚的表达其自身的属性，避免字义含糊不清，例如：
mouseeventhandler，而非mseevthdlr。
请再次注意这条规定，这样做得的好处是非常明显的。
它能明确的表达表达式所定义的含义。
dojo.events.mouse.handler//而非dojo.events.mouse.mouseeventhandler
15）.类/构造函数可以使用扩展其基类的名称命名，这样可以正确、迅速的找到其基类的名称：
eventhandleruieventhandlermouseeventhandler
基类可以在明确描述其属性的前提下，缩减其命名：
mouseeventhandlerasopposedtomouseuieventhandler.
2.1.2特殊命名规范
1）.术语"
get/set"
不要和一个字段相连，除非它被定义为私有变量。
2）.前面加"
is"
的变量名应该为布尔值，同理可以为"
has"
"
can"
或者"
should"
。
3）.术语"
compute"
作为变量名应为已经计算完成的变量。
4）.术语"
find"
作为变量名应为已经查找完成的变量。
5）.术语"
initialize"
init"
作为变量名应为已经实例化（初始化）完成的类或者其他类型的变量。
6）.ui（用户界面）控制变量应在名称后加控制类型，例如：
leftcombobox,topscrollpane。
7）.复数必须有其公共的名称约定（原文：
pluralformmustbeusedtonamecollections）。
8）.带有"
num"
count"
开头的变量名约定为数字（对象）。
9）.重复变量建议使用"
i"
j"
k"
（依次类推）等名称的变量。
10）.补充用语必须使用补充词，例如：
get/set,add/remove,create/destroy,start/stop,insert/delete,begin/end,etc.11）.能缩写的名称尽量使用缩写。
12）.避免产生歧义的布尔变量名称，例如：
isnoterror,isnotFound为非法
13）.错误类建议在变量名称后加上"
exception"
error"
14）.方法如果返回一个类，则应该在名称上说明返回什么；
如果是一个过程，则应该说明做了什么。
2.2详细命名规范2.2.1布局
1）.缩进请使用4个空白符的制表位。
2）.表达式的缩进与变量声明应为一致的。
3）.代码折叠必须看起来是完成并且是合乎逻辑的：
4）.函数的参数应采用明确的缩进，缩进规则与其他块保持一致。
2.2.2变量
1.变量必须在声明初始化以后才能使用，即便是null类型。
2.变量不能产生歧义。
篇二：
js代码规范
pms（java）编程规范
目录
第一章概述..........................................................................................................................................4
规范制定原则......................................................................................................................................4
术语定义..............................................................................................................................................4
pascal大小写.................................................................................................................................4
camel大小写.................................................................................................................................4
文件命名组织......................................................................................................................................4
1.3.1文件命名.................................................................................................................................4
1.3.2文件注释.................................................................................................................................4
第二章代码外观................................................................................................................................5
2.1
2.2
2.3
2.4
2.5
2.6
2.7列宽.........................................................................................................................................5换行.........................................................................................................................................5缩进.........................................................................................................................................5空行.........................................................................................................................................5空格.........................................................................................................................................5括号-（）...................................................................................................................................6
花括号-{}..............................................................................................................................6
第三章程序注释....................................................................................................................................7
3.1
3.2
3.3
3.4
3.5注释概述.................................................................................................................................7文档型注释.............................................................................................................................7类c注释.................................................................................................................................8单行注释.................................................................................................................................8注释标签.................................................................................................................................8
第四章申明........................................................................................................................................11
4.1
4.2
4.3每行声明数...........................................................................................................................11初始化...................................................................................................................................11位置.......................................................................................................................................11
第五章命名规范................................................................................................................................12
5.1
5.2
5.3
5.4
5.5
5.6
5.7
5.8
5.9命名概述...............................................................................................................................12缩写.......................................................................................................................................12类...........................................................................................................................................13属性.......................................................................................................................................14参数.......................................................................................................................................14方法.......................................................................................................................................14事件.......................................................................................................................................15变量.......................................................................................................................................15常量.......................................................................................................................................15
第六章语句........................................................................................................................................15
6.1每行一个语句.......................................................................................................................15
6.2
6.3
6.4
6.5
6.7.
6.9.
6.10.复合语句...............................................................................................................................15RetuRn语句............................................................................................................................16iF、iF-else、iFelse-iF语句.............................................................................................16while语句...........................................................................................................................17switch-case语句..............................................................................................................17tRy-catch语句................................................................................................................18with块语句.......................................................................................................................186.4FoR、FoReach语句....................................................................................................................17
第一章概述
规范制定原则
1方便代码的交流和维护。
2不影响编码的效率，不与大众习惯冲突。
3使代码更美观、阅读更方便。
4使代码的逻辑更清晰、更易于理解。
术语定义
pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。
可以对三字符或更多字符的标识符使用pascal大小写。
backcolor
camel大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。
文件命名组织
1.3.1文件命名
1文件名遵从pascal命名法，无特殊情况，扩展名小写。
2使用统一而又通用的文件扩展名：
js文件.js
1.3.2文件注释
1在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
//文件名：
//文件功能描述：
//
//文件调用/依赖关系：
//创建标识：
//修改标识：
//修改描述：
//----------------------------------------------------------------*/
文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。
如：
黄小文20xx0408
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
文件调用/依赖关系说明调用或者依赖的关系，如新增变压器文件,在文件调用/依赖关系说明中表明:
调用pRoject-home\dialogs\sb\bdsb\bpsb_select.jsp，录入基本运行参数；
如果调用服务器代码则表明：
包名/类名（方法名），如设备包\一次设备（createbyq（businessdatap_bd,stringp_attrco））
第二章代码外观
2.1列宽
代码列宽控制在110字符左右。
2.2换行
当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
2.3缩进
缩进应该是每行一个tab（4个空格），不要在代码中使用ta
升级会员 