如何在我在 node.js 上运行的脚本中使用 jsdoc？答案

【问题标题】：How to use jsdoc in my script running on node.js?如何在我在 node.js 上运行的脚本中使用 jsdoc？
【发布时间】：2013-12-13 23:13:59
【问题描述】：

我想使用jsdoc 模块从一些源代码中提取文档条目。我已经安装了jsdoc 模块，我可以在命令行中使用jsdoc。但是当我在我的代码中require("jsdoc") 时，nodejs 会抛出一个错误说Cannot find module 'jsdoc'。

我有 nodejs v0.8.25 和 JSDoc 3.3.0-alpha2。它在本地和全局安装。我可以使用jsdoc 命令，我的node_modules 文件夹中有jsdoc。我看不出问题出在哪里。

我在哪里可以找到一些关于jsdoc 的文档，除了如何在命令行界面中使用它或如何记录 js 源代码。我想要一些 API 文档。

【问题讨论】：

你是如何安装 jsdoc 的？ npm install jsdoc --save?另外，作为一个完整的旁注，您可能希望将您的节点更新到最新的 0.10.2x
我更改为最新版本的 nodejs，并使用此命令安装 jsdoc。我可以在命令行界面中使用它。我仍然不能在我的脚本中要求这个模块。
您能否更新您的帖子以说明在您的npm install jsdoc --save 之后是否有jsdoc 目录在您的node_modules 目录中？

【解决方案1】：

我也想将 jsdoc 用作库，但我偶然发现了和你一样的问题。你没有做错任何事，只是从来没有打算用作图书馆。

jsdoc 的 github 项目页面上有 an issue 与此相关。 Hegemonic，JSDoc的主要贡献者说：

JSDoc 并非真正设计为用作库

您可能想表达您希望针对上面链接的问题为 nodejs 创建 API。

require('jsdoc') 失败，因为 jsdoc 的 package.json 中没有声明 main 字段。它可能默认为“index.js”或“main.js”，但也没有这样的文件。

【讨论】：

【解决方案2】：

听起来你没有正确安装 jsdoc。从命令行运行npm install -g jsdoc。如果您在默认目录中的新终端窗口中运行它，您应该没有任何问题。我在尝试从当前工作目录全局安装节点模块时遇到问题，无论出于何种原因，该模块都没有全局安装。

【讨论】：

【解决方案3】：

如果是一般的自动文档工具，你也可以使用YUIDoc。

按照这三个步骤，您将获得自动文档：

【讨论】：