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

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

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

在哪里可以find一些关于jsdoc文档, jsdoc不是如何在命令行界面中使用它或者如何loggingjs源代码。 我想要一些API文档。

我也在用jsdoc作为一个图书馆,而我也偶然发现了同样的问题。 你没有做错什么,只是从来没有打算用作图书馆。

在jsdoc的github项目页面上有一个与此相关的问题。 JSDoc的主要贡献者霸权说:

JSDoc并不是真正被devise成用作库的

您可能想要expression您对在上面链接的问题上为nodejs创buildAPI的愿望。

require('jsdoc')失败,因为在jsdoc的package.json没有声明main域。 它可能默认为'index.js'或'main.js',但是也没有这样的文件。

这听起来像你没有正确安装jsdoc。 npm install -g jsdoc运行npm install -g jsdoc 。 如果你在默认目录下的一个新的terminal窗口中运行这个,你不应该有任何问题。 我遇到了一些问题,我试图从当前的工作目录中全局安装一个节点模块,无论出于什么原因模块不能全局安装。

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

遵循以下三个步骤,您将拥有自动文档:

  1. 安装它: npm -g install yuidocjs
  2. 格式化您对YUIDoc语法参考的意见
  3. 在你的控制台运行yuidoc . 在你的JS源代码树的顶部