JSDoc 技术文档

1. 安装指南

JSDoc 支持稳定的 Node.js 8.15.0 及以上版本。您可以选择全局安装或安装在项目中的 node_modules 文件夹。

全局安装

使用 npm 全局安装（可能需要 sudo；了解如何解决这个问题）：

npm install -g jsdoc

局部安装

使用 npm 将最新版本安装在本地，并保存在项目的 package.json 文件中：

npm install --save-dev jsdoc

注意：默认情况下，npm 会在版本号前添加 caret 操作符（例如 ^3.6.3）。我们建议使用 tilde 操作符（例如 ~3.6.3），这样会限制更新到最近的补丁级别的版本。有关 caret 和 tilde 操作符的更多信息，请查看 这个 Stack Overflow 答案。

2. 项目使用说明

如果本地安装了 JSDoc，命令行工具将在 ./node_modules/.bin 中可用。要为文件 yourJavaScriptFile.js 生成文档：

./node_modules/.bin/jsdoc yourJavaScriptFile.js

如果全局安装了 JSDoc，可以直接运行 jsdoc 命令：

jsdoc yourJavaScriptFile.js

默认情况下，生成的文档会保存在名为 out 的目录中。您可以使用 --destination（-d）选项指定其他目录。

运行 jsdoc --help 可以查看完整的命令行选项。

3. 项目 API 使用文档

JSDoc 的 API 文档可以在 jsdoc.app 上找到。如果您想为 JSDoc 贡献文档，可以在 jsdoc/jsdoc.github.io 进行。

4. 项目安装方式

请参考上述“安装指南”部分，根据您的需求选择全局安装或局部安装。

• 全局安装：适用于所有项目，但可能需要管理员权限。
• 局部安装：适用于特定项目，无需管理员权限，且版本控制更精确。

以上就是 JSDoc 的技术文档，希望对您有所帮助。如果在使用过程中有任何问题，欢迎加入 JSDoc 的 Slack 频道，或在 Stack Overflow 上提问。