Loading [MathJax]/jax/output/CommonHTML/config.js
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >如何在本地项目中使用jsdoc

如何在本地项目中使用jsdoc
EN

Stack Overflow用户
提问于 2016-06-23 03:00:38
回答 1查看 3.8K关注 0票数 3

目标

我想在npm中使用jsdocs

背景

我是新的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。

摘要

最后,我正在寻找一种方法在本地运行jsdoc到一个带有npm的项目。有人知道怎么做吗?

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2016-06-23 03:41:03

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

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

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

票数 5
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/37989710

复制
相关文章
PHPDoc、JSDoc、Vue JSDoc相关的语法,持续记录
@param参数类型 $参数名称 参数说明 - 用于指定一个函数或方法的参数类型、名称和说明。
房东的狗丶
2023/10/18
3870
如何在本地使用Docker安全扫描
Docker和Snyk最近建立了合作伙伴关系,以提供容器漏洞扫描。这对您意味着什么?Snyk现在与Docker Hub集成在一起,可以扫描官方镜像。此外,Docker已将Snyk扫描直接集成到Docker Desktop客户端中。
用户5166556
2023/03/18
1.5K0
如何在本地使用Docker安全扫描
使用composer本地开发项目
哈哈,所以就使用composer重新代码重写了一下,顺便记录下在本地使用composer开发项目的步骤
码缘
2020/09/01
7280
使用JSDoc提高代码的可读性
首先,JSDoc 并不会对源码产生任何的影响,所有的内容都是写在注释里边的。 所以并不需要担心 JSDoc 会对你的程序造成什么负面影响。
贾顺名
2019/12/09
1.4K0
使用JSDoc提高代码的可读性
如何在小程序中调用本地接口
如何在小程序中调用本地接口 背景: 随着微信小程序开始公测,我司也拿到了AppID,所以开始了微信小程序的趟坑之旅。 由于现在网上已经有很多的《微信小程序从精通到入门》的教程了,所以就不再重复那些,只是讲一下,在开发的过程中,如何使用本地(开发环境)的接口。 因为小程序的开发文档中写到了,wx.request 中的URL只能是一个https请求,本地一般来讲是不会有https的-.- 所以我们使用Charles代理来实现需求。 前提: 本人认为你现在已经具备以下几个条件: 具有微
贾顺名
2018/04/12
2.9K0
如何在小程序中调用本地接口
gradle使用本地maven仓库_gradle引用本地项目
使用gradle编译一个开源项目时,发现下载依赖包比较慢,打开项目下的build.gradle文件:
全栈程序员站长
2022/11/15
2.4K1
gradle使用本地maven仓库_gradle引用本地项目
如何在本地运行查看github上的开源项目
看中了一款很多星星的github的项目,想把这个项目拉到自己的电脑上运行查看项目效果,该怎么做? 示例:我们今天要看的 github项目地址:https://github.com/lzxb/vue-cnode 1.克隆项目: git clone [https://github.com/lzxb/vue-c...](https://github.com/lzxb/vue-cnode.git) 2.安装nodejs 3.安装依赖: npm install 4.启动服务: npm run dev 1:找到克隆的
王小婷
2018/07/04
2.3K0
如何在Win10系统下使用Git把本地项目上传到Github?
git status 命令,用于查看当前状态;git add . 命令,用于把项目添加到仓库;git commit -m "" 命令,用于把项目提交到仓库,要养成写注释的好习惯。
陆勤_数据人网
2021/04/02
1.6K0
如何在项目优雅使用webp
使用picture标签,这个是html5新加的标签,浏览器支持情况,可以见caniuse
用户2845596
2021/01/21
1.1K0
git clone 一个 SpringBoot 项目,如何在本地运行?
git clone 一个 SpringBoot 项目,如何在本地运行? 一、导入项目 1、点开Project Structure 2、配置jdk信息 3、创建out文件夹 4、指定src为source
RAIN7
2023/03/20
1.4K0
git clone 一个 SpringBoot 项目,如何在本地运行?
Tip | 使用GitHubDesktop提交 本地existing项目
点击File,下拉菜单中点击New Repository (或者直接Ctrl + N):
凌川江雪
2019/07/01
5400
Tip | 使用GitHubDesktop提交 本地existing项目
快速学习-使用域名访问本地项目
如果不同环境使用不同的ip去访问,可能会出现一些问题。为了保证所有环境的一致,我们会在各种环境下都使用域名来访问。
cwl_java
2020/02/11
5.1K0
windows中使用Git上传本地项目到Github的仓库中
详细操作如下图所示:
黑泽君
2018/10/12
7870
JSDoc支持_TypeScript笔记19
因此,对于.js文件,需要一种被 JavaScript 语法所兼容的类型标注方式,比如JSDoc:
ayqy贾杰
2019/06/12
4.2K0
JSDoc 真能取代 TypeScript?
TypeScript 我们知道,是用来给 JS 加上类型的,可以实现类型提示和编译时的类型检查。
神说要有光zxg
2023/10/25
4420
JSDoc 真能取代 TypeScript?
如何在本地以太坊测试网络hardhat中使用pancakeswap?
已经有相关的文章教程可以将pancake-swap-interface-v1部署到以太坊[2]类链上了, 例如:
Tiny熊
2022/02/18
1.9K0
如何在本地以太坊测试网络hardhat中使用pancakeswap?
如何在Spring Boot项目使用参数校验
开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验,比如非空,非null,整数值的范围,字符串的个数,日期,邮箱等等。最常见的就是我们直接写代码校验,这样以后比较繁琐,而且不够灵活。 Bean Validation 1.0(JSR-303)是一个校验规范,在spring Boot项目由于自带了hibernate validator 5(http://hibernate.org/validator/)实现,所以我们可以非常方便的使用这个特性 。 核心的pom依赖: <depen
我是攻城师
2018/05/14
1.1K0
allure报告如何在本地查看
很多朋友已经发现了,allure报告在pycharm里可以打开,但是到了本地打开后却看不到任何内容,只显示Loading。
孟船长
2022/04/12
2.5K0
allure报告如何在本地查看
如何在本地测试Fabric Code
前一篇博客讲到了如何编译本地的Fabric Code成镜像文件,那么如果我们想改Fabric源代码,实现一些Fabric官方并没有提供的功能,该怎么办呢?这时我们除了改源码,增加需要的功能外,还需要能够跑通Fabric的测试。Fabric的测试主要包括单元测试和行为测试,下面分别介绍。
深蓝studyzy
2022/06/16
8790
如何在本地测试Fabric Code
点击加载更多

相似问题

如何在本地(如ctag)使用hoogle?

15

如何在jsdoc-grunt任务中使用jsdoc选项

04

如何在JSDoc JSDoc中记录以下功能

13

Grunt JSDoc:使用jsdoc JSON文件

10

如何在jsdoc中使用接口?

150
添加站长 进交流群

领取专属 10元无门槛券

AI混元助手 在线答疑

扫码加入开发者社群
关注 腾讯云开发者公众号

洞察 腾讯核心技术

剖析业界实践案例

扫码关注腾讯云开发者公众号
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档