欢迎来到HELLO素材网! 南京网站制作选择顺炫科技
丰富的DIV CSS模版、JS,jQuery特效免费提供下载
当前位置:主页 > 建站教程 > DIVCSS教程 >

JavaScript 注释规范

发表于2019-04-15 10:13| 次阅读| 来源网络整理| 作者session

摘要:HTML与CSS都有注释,然而这两者的注释比JavaScript注释要简略的多。次要缘由是由于HTML和CSS代码相对比较简略,它们都

HTML与CSS都有注释,然而这两者的注释比JavaScript注释要简略的多。

次要缘由是由于HTML和CSS代码相对比较简略,它们都算不上真正的编程言语。

面对构造庞大且繁杂的JavaScript代码,较为科学的注释更无利于名目标团队开发,前期维护也会便利。

下面散布引见一下注释的总体准则、注释的根本语法和对常见语法构造的注释规则引荐。

一.注释总体准则:

能不注释,尽量不对代码减少注释,以缩小体积。

假设必需要注释,则注释必须详尽,格式科学,提高代码的可读性。

也就是说注释并不是用来丑化代码的,而是为了便于本人活着其余程序员的浏览便利性。

它是一种累赘,然而为了团队开发等目标又是必要的。

二.单行注释:

两个斜杠//可能创建一个单行注释,斜杠前面要添加一个空格,紧接着是注释内容。

注释的缩进需求与所注释的代码分歧,且要位于被注释代码的上面。

代码演示如下:

[JavaScript] 纯文本查看 复制代码

// HELLO素材网教程测试函数 function func() { // 用来存储定时器函数标识 let flag = null; }

三.多行注释:

/**/可能创建多行注释,也就是以"/*"末尾,"*/"完结,中间是注释内容。

既然是多行注释,人造被注释的内容是可能换行的。

尽量利用单行注释替代多行注释,假设注释函数,引荐利用多行注释。

四.函数的注释:

函数是利用最为频繁的语法构造,相对较为简单,所以良好的注释对于理解函数的性能十分有必要。

注释格式如下:

[JavaScript] 纯文本查看 复制代码

/*方法阐明 *@method 方法名 *@for 所属类名 *@param{参数类型}参数名 参数阐明 *@return {前往值类型} 前往值阐明 */

可能看到在注释的末尾于开头分别是/*与*/,详细的注释内容后面也带有一个星号,看起来愈加划一。

看一段简略的注释代码实例:

[JavaScript] 纯文本查看 复制代码

/*函数阐明 * @param {string} p1 参数1的阐明 * @param {string} p2 参数2的阐明,比较长 * 那就换行了. * @param {number=} p3 参数3的阐明(可选) * @return {Object} 前往值形容 */ function foo(p1, p2, p3) { var p3 = p3 || 10; return { p1: p1, p2: p2, p3: p3 }; }

五.模块注释:

模块注释格式如下:

[JavaScript] 纯文本查看 复制代码

/* 模块阐明 * @module 模块名 */

六.class类注释:

ES2015新增类的概念,详细参阅JavaScript class 类一章节。

类的注释格式如下:

[JavaScript] 纯文本查看 复制代码

/* 类阐明 * @class 类名 * @constructor */

因为类分为静态类与非静态类,所以@class需求与@constructor或许@static配合利用。

七.注释内容:

知道为什么需求注释,那么也就知道注释应该怎样写。

注释的目标是通知浏览者不宜觉察或许不易获取到的信息,而不是了如指掌的货色。

下面的注释就相当于废话,基本就不需求:

[JavaScript] 纯文本查看 复制代码

// 申明一个变量timer let timer=null;

只需不是JavaScript盲,都能知道上面是申明一个变量,基本用不着注释。

应该强调tmer这个变量将来要施展的作用,代码修正如下:

[JavaScript] 纯文本查看 复制代码

// 申明变量用来存储定时器函数的标识 let timer=null;

八.待办内容:

能够有些中央的代码待编写或许有些性能待完成。

那么可能利用// TODO标识进去,格式如下:

[JavaScript] 纯文本查看 复制代码

// TODO: 标注待完成的性能。

九.有bug待解决:

假设代码有些中央需求优化,甚至代码中存在谬误去批改。

那么可能利用// FIXME标注进去,格式如下:

[JavaScript] 纯文本查看 复制代码

// FIXME: 标注出现的成绩。

上面引见的仅是常见的注释,JavaScript语法构造很多,感兴味的冤家可能自行总结。