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

Question

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

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

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

Answer 1

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

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

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

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

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

Answer 2

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

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