技术标签 TAGS
专业技术精选
- 2020-03-20非常不错的骰子案例
- 2019-05-26vscode git and gitlens中文乱码问题
- 2011-12-14什么是网站制作的web标准
- 2011-12-14上海网站建设之六大不利优化因素
Javascript命名规范
编写人：6yang
日期：2010/10/13
Javascript命名规范
Ø 类/函数命名
例1.1：
var ClassName = function(){ //类名
var _FieldName = "Test Field"; //私有变量
this.PropertyName = "Test Property Name"; //属性
var functionName = function(){ //私有方法
return "";
}
this.PublicFunctionName = function(pTestName){ //公有方法 pTestName:参数
var condition = "condition"; //局部变量
if(condition){ //判断
return functionName();
}else{
}
var nameCol = ["a","b"]; //数组
var nameItem = nameCol[0]; //数组项
for(var i = 0; i < nameCol.length; i++){
//循环
}
var selectName = "item";
switch(selectName){ //选择
case "item":
break;
}
}
}
|
名称 |
A |
B |
C |
D |
|
类名 |
|
|
√ |
|
|
私有变量 |
√ |
|
|
|
|
属性 |
|
|
√ |
|
|
私有方法 |
|
√ |
|
|
|
公有方法 |
|
|
|
|
|
参数 |
|
|
|
√ |
|
局部变量 |
|
√ |
|
|
A：加 _ 下划线前缀 B：小写开头 C:大写开头 D：加小写p前缀
说明：
私有变量加下划线的原因有两个，一是区分局部私有、变量、参数这三者的名称；二是对于个别编辑器可以直接按下下划线就提示出来，方便开发。
参数的p 是 parameter 的缩写，意思是参数。加前缀的原因同上。
特殊例子：数组，后加Col (Col 是Collective的缩写是集体的意思);
数组项，后加Item;
DOM标签对象，后加Box
判断语句：
if(condition){
//Code;
}
else{
//Code;
}
循环语句：
for(var i = 0; i < nameCol.length; i++){
//Code;
}
选择语句：
var selectName = "item";
switch(selectName){
case "item":
break;
}
注: 页面过程级函数的命名方法与公有方法的命名方法相同。
Ø 注释
说明：以下例子，灰颜色字体的是说明。
1． 注释函数/类
例1.2:
/**
* FunctionName (函数名/类名)
* dec: 函数说明 (描述内容)
* @param {String} tag (String 是数据类型 tag是名称)
* @return {Boolean} (Boolean是数据类型对 对象:object 数组:array 字符:string 数字:int )
*/
var FunctionName = function(tag){
}
2． 函数内部实现代码
例1.2:
var FunctionName = function(tag){
var _FieldName = "Test Field"; /*私有变量注释*/
this.PropertyName = "Test Property Name"; /*属性注释*/
var functionName = function(){ /*私有方法注释*/
return "";
}
this.PublicFunctionName = function(pTestName){ /*公有方法注释*/
var condition = "condition"; /*局部变量注释*/
if(condition){
return functionName();
}else{
}/*判断语句注释*/
for(var i = 0; i < nameCol.length; i++){
}/*循环语句注释*/
var selectName = "item";
switch(selectName){
case "item":
break;
}/*选择语句注释*/
}
}
注意：由于在压缩JS的时候”//”这样的注释会引起压缩代码出现问题的可能，所以一律改为”/**/”