使用 JSDoc 自动生成 JavaScript 方法的 Markdown 文档

对于 JavaScript 中的方法，可以使用 JSDoc 注释来自动生成方法的 Markdown 文档。JSDoc 是一种用于为 JavaScript 代码生成 API 文档的工具。它使用一组特殊的注释标记来描述代码中的函数、类、变量等元素，并生成与之相关的 API 文档。

以下是使用 JSDoc 注释来自动生成方法的 Markdown 文档的步骤：

1. 在方法定义前添加 JSDoc 注释，格式为：

/**
 * 方法描述
 * @param {参数类型} 参数名 参数描述
 * @return {返回值类型} 返回值描述
 */

2. 在注释中使用标记描述方法的参数、返回值等信息。例如：

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

3. 安装 JSDoc 工具，可以使用 npm 进行安装：

npm install -g jsdoc

4. 在命令行中使用 JSDoc 命令生成 Markdown 文档：

jsdoc path/to/your/code.js -t path/to/template -d path/to/output/directory

其中，-t 参数指定生成文档的模板，可以使用默认的模板或自定义模板；-d 参数指定生成文档的输出目录；path/to/your/code.js 是要生成文档的 JavaScript 代码文件。

5. 执行命令后，JSDoc 将会根据注释生成 Markdown 文档，并输出到指定的输出目录中。

注意：为了使 JSDoc 能够正确解析注释，注释必须放在方法定义前，并且遵循 JSDoc 注释的规范。使用 JSDoc 注释生成的文档可以大大提高文档编写效率，同时也可以保证文档的准确性和一致性。