如何在本地项目中使用jsdoc
how to use jsdoc in local project
目标
我想将 jsdocs 与 npm 一起使用。
背景
我是 npm 及其插件的新手。最近我发现了 jsdoc 并尝试使用它,但没有成功。
我试过的
首先我使用 npm 的命令 npm install --save jsdoc
安装了包,安装成功完成。
但是,当我尝试在我的项目中使用它时(我在项目的文件夹中),我输入 jsdoc example.js
并收到以下错误:
/home/ubuntu/.nvm/versions/node/v4.4.5/bin/jsdoc: No such file or
directory
这让我认为:
- 我在错误的目录中。如果是这样,我应该在哪里? (项目根文件夹除外)
- 安装有问题,尽管它是成功的。
我也试过 运行 npm jsdoc example.js
但是我得到了另一个错误(这次是来自 npm,说我没有正确使用它)。
我还全局安装了 jsdoc(使用 -g
标志)并且它有效,但我真的想避免这种情况,因为并非所有项目都使用 jsdoc。
总结
总而言之,我正在寻找一种方法 运行 jsdoc 本地到带有 npm 的项目。有谁知道这样做的方法吗?
到命令行中的运行jsdoc,需要知道jsdoc所在的位置。所以当你全局安装了jsdoc后,系统就可以找到这个文件了。
但是,如果您想 运行 在本地,您需要在 jsdoc 命令之前包含文件位置。
例如,尝试使用 ./node_modules/jsdoc/jsdoc.js example.js
目标
我想将 jsdocs 与 npm 一起使用。
背景
我是 npm 及其插件的新手。最近我发现了 jsdoc 并尝试使用它,但没有成功。
我试过的
首先我使用 npm 的命令 npm install --save jsdoc
安装了包,安装成功完成。
但是,当我尝试在我的项目中使用它时(我在项目的文件夹中),我输入 jsdoc example.js
并收到以下错误:
/home/ubuntu/.nvm/versions/node/v4.4.5/bin/jsdoc: No such file or directory
这让我认为:
- 我在错误的目录中。如果是这样,我应该在哪里? (项目根文件夹除外)
- 安装有问题,尽管它是成功的。
我也试过 运行 npm jsdoc example.js
但是我得到了另一个错误(这次是来自 npm,说我没有正确使用它)。
我还全局安装了 jsdoc(使用 -g
标志)并且它有效,但我真的想避免这种情况,因为并非所有项目都使用 jsdoc。
总结
总而言之,我正在寻找一种方法 运行 jsdoc 本地到带有 npm 的项目。有谁知道这样做的方法吗?
到命令行中的运行jsdoc,需要知道jsdoc所在的位置。所以当你全局安装了jsdoc后,系统就可以找到这个文件了。
但是,如果您想 运行 在本地,您需要在 jsdoc 命令之前包含文件位置。
例如,尝试使用 ./node_modules/jsdoc/jsdoc.js example.js