Javascript 如何在node.js上运行的脚本中使用jsdoc?
我想使用Javascript 如何在node.js上运行的脚本中使用jsdoc?,javascript,node.js,require,jsdoc,Javascript,Node.js,Require,Jsdoc,我想使用jsdoc模块从一些源代码中提取文档条目。 我已经安装了jsdoc模块,可以在命令行中使用jsdoc。 但是当我在代码中require(“jsdoc”)时,nodejs抛出一个错误,说找不到模块“jsdoc” 我有nodejsv0.8.25和jsdoc3.3.0-alpha2。它安装在本地和全球。 我可以使用jsdoc命令,我的node\u modules文件夹中有jsdoc。 我看不出问题出在哪里 除了如何在命令行界面中使用它或如何记录js源代码之外,我在哪里可以找到一些关于jsdoc
jsdoc
模块从一些源代码中提取文档条目。
我已经安装了jsdoc
模块,可以在命令行中使用jsdoc
。
但是当我在代码中require(“jsdoc”)
时,nodejs抛出一个错误,说找不到模块“jsdoc”
我有nodejsv0.8.25和jsdoc3.3.0-alpha2。它安装在本地和全球。
我可以使用jsdoc
命令,我的node\u modules
文件夹中有jsdoc
。
我看不出问题出在哪里
除了如何在命令行界面中使用它或如何记录js源代码之外,我在哪里可以找到一些关于
jsdoc
的文档。我想要一些API文档。如果它是关于一般的自动文档工具,您也可以使用
按照这三个步骤,您将拥有自动文档:
npm-g安装yuidocjs
yuidoc.
听起来你没有正确安装jsdoc。从命令行运行npm install-gjsdoc。如果在默认目录下的新终端窗口中运行此操作,则不会出现任何问题。我遇到过这样的问题:我试图从当前工作目录全局安装节点模块,但由于任何原因,该模块没有全局安装 我也希望将jsdoc用作一个库,但我无意中发现了与您相同的问题。 你没有做错什么,只是从来没有打算把它用作图书馆 在jsdoc的github项目页面上有与此相关的内容,JSDoc的主要贡献者说: JSDoc并不是真正设计用来作为库的 您可能希望就上面链接的问题为nodejs创建一个API
require('jsdoc')
失败,因为jsdoc的package.json
中没有声明main
字段。它可能默认为“index.js”或“main.js”,但也没有这样的文件。您是如何安装jsdoc的<代码>npm安装jsdoc--保存?另外,作为一个完整的旁注,您可能希望将您的节点更新为最新的0.10.2xI更改为最新版本的nodejs,并使用此命令安装jsdoc。我可以在命令行界面中使用它。我仍然无法在脚本中要求使用此模块。能否更新您的帖子,以表明在npm安装jsdoc--save
之后,您的node\u modules
目录中是否有jsdoc
目录?这个问题是关于jsdoc的。。虽然类似,但JSDoc和YUIDoc使用/需要不同的doclet(并且JSDoc支持“代码检查”)。