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

时间:2013-11-28 03:36:01

标签: javascript node.js require jsdoc

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

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

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

3 个答案:

答案 0 :(得分:6)

我当时也希望将jsdoc用作库,我偶然发现了和你一样的问题。 你没有做错任何事,它从来没有打算用作图书馆。

jsdoc的github项目页面上有an issue与此相关。 Hegemonic,JSDoc的主要撰稿人说:

  

JSDoc实际上并不是设计用作库

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

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

答案 1 :(得分:-1)

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

答案 2 :(得分:-3)

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

按照以下三个步骤,您将获得自动文档:

  1. 安装它:npm -g install yuidocjs
  2. 格式化有关YUIDoc Syntax Reference
  3. 的评论
  4. 在您的控制台中,在JS源代码树上运行yuidoc .