首页 > 社交 > 科普中国

JavaScript

常驻编辑 科普中国 2022-10-16 注释   变量   语句   函数   对象   规则   原则   错误   案例   代码   建议
4JA拜客生活常识网

1) 建议一:变量如果设置为私有变量,函数为私有函数,则前面添加下划线进行标注;公有变量和函数不添加下划线4JA拜客生活常识网

实例一:4JA拜客生活常识网

var MyClass = function() {undefined4JA拜客生活常识网

var _thisTotal = 0;4JA拜客生活常识网

var _doSomething = function() {};4JA拜客生活常识网

this.getThisTotal = function() {undefined4JA拜客生活常识网

return _thisTotal;4JA拜客生活常识网

};4JA拜客生活常识网

};4JA拜客生活常识网

var myClassInstance = new MyClass();4JA拜客生活常识网

myClassInstance.total = myClassInstance. getThisTotal();4JA拜客生活常识网

实例二:4JA拜客生活常识网

function MyClass() {undefined4JA拜客生活常识网

this._thisTotal = 0;4JA拜客生活常识网

this._doSomething = function() {};4JA拜客生活常识网

}4JA拜客生活常识网

MyClass.prototype.getThisTotal = function() {undefined4JA拜客生活常识网

return this._thisTotal;4JA拜客生活常识网

};4JA拜客生活常识网

var myClassInstance = new MyClass();4JA拜客生活常识网

myClassInstance.total = myClassInstance.getThisTotal();4JA拜客生活常识网

2) 建议二:前面加"is" 的变量名应该为布尔值,同理 "has","can" 或者 "should"亦如此;4JA拜客生活常识网

3) 建议三:重复变量建议使用"i", "j", "k" (依次类推)等名称的变量;4JA拜客生活常识网

4) 建议四:全局变量、常量应该全部大写;4JA拜客生活常识网

5) 建议五:术语"initialize" 或者 "init" 作为变量名应为已经实例化(初始化)完成的类或者其他类型的变量;为函数,应为初始化操作。4JA拜客生活常识网

2代码组织规范4JA拜客生活常识网

基本原则:利于个人开发,便于相互交流。4JA拜客生活常识网

【说明】:因个人习惯和编辑器等可以设置而形成自己独特的风格,但必须前后一致,并符合本规范的基本规则、建议和格式。4JA拜客生活常识网

2.1缩排4JA拜客生活常识网

原则:4JA拜客生活常识网

(1)代码中以TAB(4个字符)缩进,在编辑器中请将TAB设置为相同的长度,否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式;4JA拜客生活常识网

(2)同一代码块中的代码对齐,这里所说的代码块,包括但不限于:function、if else语句、while、for等,即使用{}包围的代码。4JA拜客生活常识网

2.1注释4JA拜客生活常识网

原则:不吝惜代码注释,重要函数、变量必须添加注释;特殊函数、变量、常量必须添加注释。4JA拜客生活常识网

注释的格式,可参考如下所示:4JA拜客生活常识网

1)变量注释:4JA拜客生活常识网

// 初始化序列号4JA拜客生活常识网

var index = 0;4JA拜客生活常识网

var index = 0; // 初始化序列号4JA拜客生活常识网


4JA拜客生活常识网

2)函数注释,包括a.函数描述及其功能说明;b.参数描述应包括类型、参数名、参数描述;有返回值的需要对返回值进行相应描述:4JA拜客生活常识网

/**4JA拜客生活常识网

* 绑定事件4JA拜客生活常识网

* @param {Object} $detailDom 当前变更详情页面主体DOM对象4JA拜客生活常识网

* @return null4JA拜客生活常识网

*/4JA拜客生活常识网

function _bindEvent($detailDom) {undefined4JA拜客生活常识网


4JA拜客生活常识网

/**4JA拜客生活常识网

* 查看专线详情4JA拜客生活常识网

* @param {jQueryObject} $grid 列表DOM容器4JA拜客生活常识网

* @param {String} selector 需要添加详情链接的选择器4JA拜客生活常识网

* @param {Boolean} needSpecialId 是否需要指定其他特定id,默认不传,即false4JA拜客生活常识网

* @param {String} specialIdName needSpecialId为true,此值必传,即指定id的属性名称4JA拜客生活常识网

* @return {Boolean} result 操作是否成功4JA拜客生活常识网

*/4JA拜客生活常识网

viewDetail: function($grid, selector, needSpecialId, specialIdName) {undefined4JA拜客生活常识网

var self = this;4JA拜客生活常识网


4JA拜客生活常识网


4JA拜客生活常识网

3)文件注释,应该包含文件描述、功能简介和作者,还可以加上创建时间:4JA拜客生活常识网

/**4JA拜客生活常识网

* 本js实现专线续费申请页面所有功能4JA拜客生活常识网

* @author xuweijian4JA拜客生活常识网

* @date 2015/10/12 15:25:334JA拜客生活常识网

*/4JA拜客生活常识网

$(function() {undefined4JA拜客生活常识网


4JA拜客生活常识网

4)行注释与块注释:使用 //…的注释方法来注释需要表明的内容;使用/**和*/注释的方法来注释需要表明的内容。4JA拜客生活常识网

3 编码规范4JA拜客生活常识网

相关阅读:

  • 如何添加注释(word文档怎么添加注释编号)
  • pdf如何标注(PDF文件如何添加注释)
  • 「Leetcode刷题」「33」搜索旋转排序数组.py
  • 韩国KBS电视台主持人搭配绝了
  • 人间多少花月梦
  • 城市数字孪生体帮助训练深度学习模型以分离建筑立面
  • 江城子密州出猎原文及注释 《江城子.密州出猎》翻译
  • 晏殊的《浣溪沙》原文 晏殊的浣溪沙原文及翻译 浣溪沙
  • 浪淘沙欧阳修古诗文网 欧阳修的浪淘沙表达了什么 浪淘
  • 中国广电上线192套餐6折营销,充多少送多少,看看还有什么
    • 网站地图 |
    • 声明:登载此文出于传递更多信息之目的,并不意味着赞同其观点或证实其描述。文章内容仅供参考,不做权威认证,如若验证其真实性,请咨询相关权威专业人士。