关键词

javascript三种代码注释方法

JavaScript中有三种注释方法:单行注释、多行注释和文档注释。

1. 单行注释

单行注释用于注释一行代码,使用双斜杠(//)开头。

示例:

// 这是一行单行注释
console.log("Hello World!");

输出结果:

Hello World!

2. 多行注释

多行注释用于注释多行代码,使用斜杠星号(/*)作为开始标记、星号斜杠(*/)作为结束标记。

示例:

/*
这是多行注释的示例
它可以注释多行代码,比如下面的循环语句
*/
for (var i = 0; i < 10; i++) {
  console.log(i);
}

输出结果:

0
1
2
3
4
5
6
7
8
9

3. 文档注释

文档注释用于注释函数和类,它可以被文档生成工具识别并生成文档。

文档注释以斜杠星号两个星号(/**)作为开始标记,星号斜杠(*/)作为结束标记。注释以 @ 开头,用于标识特定的注释类型。

文档注释支持的注释类型有:

  • @param 用于定义函数参数
  • @return 用于定义函数返回值
  • @throws 用于定义异常
  • @see 用于定义参考文档
  • @version 用于定义版本号

示例:

/**
 * 计算两个数字的和
 * @param {number} num1 - 第一个数字
 * @param {number} num2 - 第二个数字
 * @return {number} 两个数字的和
 */
function add(num1, num2) {
  return num1 + num2;
}

以上是Javascript三种注释方法的详细攻略。

本文链接:http://task.lmcjl.com/news/1003.html

展开阅读全文