javascript - 如何在运行在 node.js 上的脚本中使用 jsdoc？

Question

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

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

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

Answer 1

我也想将 jsdoc 用作库，但我偶然发现了与您相同的问题。您没有做错任何事，只是从未打算将其用作图书馆。

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

JSDoc isn't really designed to be used as a library

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

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