JavaScript 注释语法

在编写 JavaScript 代码时，注释是非常重要的。它可以帮助其他程序员理解你的意图并且使代码更易于维护。

JavaScript 有两种注释语法：单行注释和多行注释。

单行注释

单行注释用于注释一行代码。它由两个斜杠（//）开始，并且从这个点开始一直到这一行结尾都是注释。例如：

// 这是一个单行注释

注释语句也可以出现在代码后面，例如：

let name = 'Tom'; // 定义变量 name 并赋值为 'Tom'

多行注释

多行注释用于注释多行代码。它由一个斜杠后跟一个星号（/）开始，在这个点之后的所有内容都被注释，一直到下一个星号后跟斜杠（/）结束。例如：

/*
这是一个多行注释，可以跨越多行。
注意，这只是一个注释，代码不会执行。
*/

JSDoc 注释

JSDoc 注释是一种特殊的注释语法，可以用于生成 API 文档。它由一个斜杠后跟两个星号和一组符号（/** @name */）开始，并且包含一些特殊的标记，用于描述代码的参数、返回值和其他重要信息。例如：

/**
 * 这是一个 JSDoc 注释，用于描述一个函数
 * @param {string} name - 姓名
 * @returns {string} 一个拼接了姓名和问候语的字符串
 */
function greeting(name) {
  return `Hello, ${name}!`;
}

在上面的例子中，@param 标记用于描述函数参数，@returns 标记用于描述函数的返回值。

总结

注释是编写 JavaScript 代码时的重要部分之一。它可以帮助其他程序员理解你的意图并且使代码更易于维护。

在 JavaScript 中，有两种注释语法：单行注释和多行注释。同时，JSDoc 注释是一种特殊的注释语法，用于描述代码的参数、返回值和其他重要信息。