如何在节点上运行的脚本中使用 jsdoc.js

How to use jsdoc in my script running on node.js?

本文关键字：jsdoc js 脚本 节点 运行      更新时间：2023-12-11

我想使用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 文档。

我也

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

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

JSDoc并不是真正设计为用作库的。

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

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

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

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

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

  1. 安装方式：npm -g install yuidocjs
  2. 设置有关 YUIDoc 语法参考的注释的格式
  3. 在控制台中，在 JS 源代码树上运行yuidoc .
相关文章：