1) 建议一:变量如果设置为私有变量,函数为私有函数,则前面添加下划线进行标注;公有变量和函数不添加下划线
实例一:
var MyClass = function() {undefined
var _thisTotal = 0;
var _doSomething = function() {};
this.getThisTotal = function() {undefined
return _thisTotal;
};
};
var myClassInstance = new MyClass();
myClassInstance.total = myClassInstance. getThisTotal();
实例二:
function MyClass() {undefined
this._thisTotal = 0;
this._doSomething = function() {};
}
MyClass.prototype.getThisTotal = function() {undefined
return this._thisTotal;
};
var myClassInstance = new MyClass();
myClassInstance.total = myClassInstance.getThisTotal();
2) 建议二:前面加"is" 的变量名应该为布尔值,同理 "has","can" 或者 "should"亦如此;
3) 建议三:重复变量建议使用"i", "j", "k" (依次类推)等名称的变量;
4) 建议四:全局变量、常量应该全部大写;
5) 建议五:术语"initialize" 或者 "init" 作为变量名应为已经实例化(初始化)完成的类或者其他类型的变量;为函数,应为初始化操作。
2代码组织规范
基本原则:利于个人开发,便于相互交流。
【说明】:因个人习惯和编辑器等可以设置而形成自己独特的风格,但必须前后一致,并符合本规范的基本规则、建议和格式。
2.1缩排
原则:
(1)代码中以TAB(4个字符)缩进,在编辑器中请将TAB设置为相同的长度,否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式;
(2)同一代码块中的代码对齐,这里所说的代码块,包括但不限于:function、if else语句、while、for等,即使用{}包围的代码。
2.1注释
原则:不吝惜代码注释,重要函数、变量必须添加注释;特殊函数、变量、常量必须添加注释。
注释的格式,可参考如下所示:
1)变量注释:
// 初始化序列号
var index = 0;
var index = 0; // 初始化序列号
2)函数注释,包括a.函数描述及其功能说明;b.参数描述应包括类型、参数名、参数描述;有返回值的需要对返回值进行相应描述:
/**
* 绑定事件
* @param {Object} $detailDom 当前变更详情页面主体DOM对象
* @return null
*/
function _bindEvent($detailDom) {undefined
/**
* 查看专线详情
* @param {jQueryObject} $grid 列表DOM容器
* @param {String} selector 需要添加详情链接的选择器
* @param {Boolean} needSpecialId 是否需要指定其他特定id,默认不传,即false
* @param {String} specialIdName needSpecialId为true,此值必传,即指定id的属性名称
* @return {Boolean} result 操作是否成功
*/
viewDetail: function($grid, selector, needSpecialId, specialIdName) {undefined
var self = this;
3)文件注释,应该包含文件描述、功能简介和作者,还可以加上创建时间:
/**
* 本js实现专线续费申请页面所有功能
* @author xuweijian
* @date 2015/10/12 15:25:33
*/
$(function() {undefined
4)行注释与块注释:使用 //…的注释方法来注释需要表明的内容;使用/**和*/注释的方法来注释需要表明的内容。
3 编码规范