JSDoc 注释规范

JSDoc 注释

在 前端项目中，注释格式包含了一些特殊标记，如 @param、@returns 等，这种注释通常是用来标记函数或方法的参数和返回值的数据类型和描述。
这种注释格式通常被称为 JSDoc 注释。在实际开发中，这样的注释可以被一些工具解析，以生成代码的文档或者提供代码的自动补全功能。

JSDoc 是一种用于 JavaScript 的文档注释标记语言，它允许开发者使用一种类似于 JavaDoc 和 PHPDoc 的方式来描述
JavaScript
代码中函数、方法、类等的参数、返回值、功能等信息。这样的注释能够帮助开发者更好地理解代码的用法和功能，并且可以通过一些工具生成文档。

以下是一个示例 JSDoc 注释的格式：

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

在这个示例中，@param {number} a 表示 add 函数接受一个数字类型的参数 a，@returns {number} 表示 add 函数返回一个数字类型的值。