我在vscode里面想通过jsdoc-to-markdown工具生成某些js文件的markdown文件,但是在执行了jsdoc2md 文件名.js 之后,控制台啥也不输出,也不报错,请大佬们救救我吧,磕头了,砰砰砰。
关注
码龄 粉丝数 原力等级 --
- 被采纳
- 被点赞
- 采纳率
执行jsdoc2md命令后啥也不输出
收起
- 写回答
- 好问题 0 提建议
- 关注问题
微信扫一扫点击复制链接分享
- 邀请回答
- 编辑 收藏 删除 结题
- 收藏 举报
1条回答 默认 最新
- 关注
码龄 粉丝数 原力等级 --
- 被采纳
- 被点赞
- 采纳率
「已注销」 2024-06-14 13:14关注我是了一下,发现是可以的,效果如下:

我的步骤:
1、使用 npm install -g jsdoc-to-markdown 命令安装jsdoc2md。
2、创建 index.js 文件并写入代码,并且加上文档注释。
3、使用 jsdoc2md index.js 命令生成 markdown 的输出。本回答被题主选为最佳回答 , 对您是否有帮助呢? 本回答被专家选为最佳回答 , 对您是否有帮助呢? 本回答被题主和专家选为最佳回答 , 对您是否有帮助呢?解决 无用评论 打赏举报 编辑记录
微信扫一扫点击复制链接分享
评论按下Enter换行,Ctrl+Enter发表内容
报告相同问题?
提交
- 2019-08-30 03:122. **转换成 Markdown**:解析后的 JSDoc 注释会被转换成 Markdown 格式,这使得文档可以直接在 GitHub 或其他支持 Markdown 的平台上展示。 3. **自定义输出**:用户可以通过指定标题来决定 Markdown 文档的结构,...
- 2021-10-04 21:41阿祥_csdn的博客 在编码的过程中,很多情况下我们都有输出 api 文档的需求,因此本文将介绍如何使用 jsdoc 输出 api 文档。
- 2023-12-26 10:22胡西风_foxww的博客 JSDoc是一个用于 JavaScript 的API文档生成器,类似于 Javadoc 或 phpDocumentor。可以将文档注释直接添加到源代码中。JSDoc 工具将扫描您的源代码并为您生成一个 HTML 文档网站。
- 2019-08-30 02:425. **运行Grunt任务**: 在命令行中,执行`grunt`命令,`grunt-jsdoc-to-markdown`会将指定的源代码文件中的JSDoc注释转换为Markdown格式,并保存到`docs/api.md`。 6. **自定义模板和配置**: 如果需要,你可以根据...
- 2020-04-21 23:53丰色木夕的博客 jsdoc https://blog.csdn.net/weixin_34006468/article/details/92717326?depth_1-utm_source=distribute.pc_relevant.none-task-blog-OPENSEARCH-3&utm_source=distribute.pc_relevant.none-task-blog-OPENSEAR...
- 2020-12-21 09:27quietness_1的博客 # 首先在全局安装(是不是项目依赖全局啊,我也不知道,求解答) npm install -g jsdoc # 当前项目安装 npm install --save-dev jsdoc # 使用方法(cmd 中运行就可以了) jsdoc XXXX.js 创建之后你可以尝试一下,...
- 2024-10-18 10:42晏沙令Lorena的博客 本文深入解析了JSDoc的核心架构,涵盖了AST解析器的工作原理、文档标签系统的设计、CLI引擎的架构以及配置管理系统。通过分析源码,揭示了JSDoc如何将JavaScript代码转换为抽象语法树,提取注释信息,并最终生成完整...
- 2021-04-01 09:30放学后的泡泡的博客 由于 我们使用了ES6高级语法,发现钟爱的 jsduck 不能用了。只能选择 jsdoc。 环境:node14 第1步:运行 npm i jsdoc -g 第2步: 编写配置文件 { "tags": { "allowUnknownTags": true }, "source": { ...
- 2019-08-15 11:39bunny_Lover的博客 安装 准备 Node.js 8.15.0+ 通过npm安装 全局安装:npm install -g jsdoc 若出现权限问题,如 EACCES报错,最佳实践为用node版本管理器(nvm等)重装npm ...鉴于JSDoc的文档生成工具的本质,建议使用 --...
- 2017-11-19 23:17weixin_34128839的博客 就会生成项目文档了,注意我这里使用的jsdoc是本地安装的jsdoc包,并不是全局安装的,这样做的目的是因为如果其他项目组成员想在他本地生成文档可能会忘了安装jsdoc以及其它的一些包。所以我就把jsdoc相关的包放到了...
- 2021-06-11 03:01华天清的博客 根据 JSDoc 规范书写注释的 JavaScript 文件,可以借助 JSDoc 工具生成标准的使用文档,也可以被 IDE 编辑器用于代码提示。JSDoc 默认的文档模板比较单调,docstrap 提供了 14+ 种 bootstrap 风格的模板,使用 ...
- 2013-08-29 07:41weixin_34344403的博客 ,实际上他们是同一个开发者开发,但是区别是grunt-jsdoc是基于JsDoc Toolkit 3而grunt-jsdoc-plugin是基于JsDoc Toolkit 2的。之前因为不知道这个区别绕了很长的一段弯路。 安装 首先检查你是否已经...
- 2025-10-19 02:48瞿兴亮Sybil的博客 本文将详细介绍如何利用JSDoc(JavaScript文档生成器)为jquery-validation项目自动生成API文档,帮助开发团队提高文档维护效率,确保代码与文档的一致性。读完本文,你将了解JSDoc的基本使用方法、jquery-...
- 2025-10-25 07:33华坦璞Teresa的博客 本文将以node-fetch项目为例,详细介绍如何利用JSDoc注释规范和TypeDoc工具链,构建自动化的API文档生成系统,彻底解决文档滞后问题。读完本文,你将掌握从代码注释提取到静态文档生成的完整流程,包括配置优化、...
- 2025-10-07 03:50祝舟连的博客 在JavaScript开发中,文档维护常常是开发者最容易忽视却至关重要的环节。wtfjs作为一个收集有趣且棘手JavaScript示例的项目([项目描述]...本文将展示如何通过JSDoc实现API文档自动化,让开发者专注于代码而非...
- 2024-08-23 08:33谢月连Jed的博客 Grunt-jsdoc 开源项目教程 本教程旨在引导您了解并使用 grunt-jsdoc 这个开源项目,它是一款基于 Grunt 的工具,用于自动生成 JavaScript 文档。我们将深入探讨其核心组件:目录结构、启动文件以及配置文件。 1. ...
- 2025-10-27 05:00羿靖炼Humphrey的博客 本文将介绍如何使用 JSDoc 为 jQuery-Cookie 项目自动生成清晰、专业的 API 文档,解决文档维护难题。读完本文,你将掌握 JSDoc 配置方法、注释规范以及自动化文档生成流程,让文档与代码保持同步。 ## 项目概述 ...
- 2025-10-01 04:46幸桔伶的博客 本文将介绍如何使用JSDoc工具为uBlock Origin项目自动生成清晰、专业的API文档,帮助开发者快速理解和使用核心功能模块。 ## 核心模块结构概览 uBlock Origin的核心功能实现分散在`src/js`目录下的多个JavaScript...
- 2025-09-24 03:47郝菡玮Echo的博客 在NodeSource的`distributions`项目中,文档生成工具(JSDoc与TypeDoc)的应用解决了多版本脚本维护的痛点。本文将从实际场景出发,详解如何通过文档工具实现脚本自动化生成,提升团队协作效率。 ## 项目背景与文档...
- 2025-10-15 06:17任凝俭的博客 你是否还在为Flowchart库的API文档维护发愁?手动编写不仅耗时易错,还难以保持与代码同步。本文将带你使用JSDoc工具,从[engine/flowy.js]...读完本文你将掌握:JSDoc注释规范、文档生成流程、自定义模...
- 没有解决我的问题, 去提问