如何在本地项目中使用jsdoc

Question

目标

我想将jsdocs与npm一起使用。

背景

我是npm及其插件的新手。最近我发现了jsdoc并尝试使用它，但没有成功。

我尝试了什么

首先我使用npm的命令npm install --save jsdoc安装了软件包，安装成功完成。

但是，当我尝试在我的项目中使用它时（我在项目的文件夹中）我输入jsdoc example.js并收到以下错误：

  

/home/ubuntu/.nvm/versions/node/v4.4.5/bin/jsdoc：没有这样的文件或   目录

这让我想到：

• 我在错误的目录中。如果是的话，我应该在哪里？ （项目根文件夹除外）
• 安装有问题，即使它成功了。

我还尝试运行npm jsdoc example.js但是我收到了另一个错误（这次是从npm开始，说我没有正确使用它）。

我还全局安装了jsdoc（使用-g标志）并且它有效，但我真的想避免这种情况，因为并非所有项目都使用jsdoc。

摘要

总而言之，我正在寻找一种方法来使用npm在本地运行jsdoc。有谁知道这样做的方法？

Answer 1

要在命令行中运行jsdoc，需要知道jsdoc的位置。因此，当您全局安装jsdoc时，系统将能够找到该文件。

但是，如果要在本地运行它，则需要在jsdoc命令之前包含文件位置。

例如，尝试使用./node_modules/jsdoc/jsdoc.js example.js