我在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-12-21 09:27quietness_1的博客 # 首先在全局安装(是不是项目依赖全局啊,我也不知道,求解答) npm install -g jsdoc # 当前项目安装 npm install --save-dev jsdoc # 使用方法(cmd 中运行就可以了) jsdoc XXXX.js 创建之后你可以尝试一下,...
- 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...
- 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的。之前因为不知道这个区别绕了很长的一段弯路。 安装 首先检查你是否已经...
- 2024-08-23 08:33谢月连Jed的博客 Grunt-jsdoc 开源项目教程 grunt-jsdocA grunt plugin to generate javascript doc by running jsdoc3 on your grunt projects.项目地址:https://gitcode.com/gh_mirrors/gr/grunt-jsdoc 本教程旨在引导您了解并...
- 2014-02-14 14:45wts的博客 之前简单介绍了如何用JSDoc3以及...JSDoc的自定义能力确实很强,我们增加一个readme.md这样的markdown格式的文件就可以了。 比如我的js文件位于:d:\myjs\,要生成的jsdoc放在d:\mydoc。 我们首先可以在任意位置创建一
- 2022-04-23 13:42坏人OvO的博客 vite2搭建项目
- 2025-05-19 14:10Code_流苏的博客 # 环境配置 - 使用Node.js v18 - 安装依赖:React, TypeScript, Jest - 代码风格:遵循项目的ESLint规则 - 测试框架:Jest # 偏好设置 - 注释风格:JSDoc - 缩进:2个空格 - 错误处理:使用try/catch而非throw 这个...
- 2021-05-22 14:302. Crow读取TypeScript编译器的输出,获取代码的类型信息。 3. 工具根据这些信息,在源代码中插入或更新注释,通常是在函数、类、接口等定义之前添加。 4. 用户可以定制注释模板,以满足特定的项目规范或个人偏好。 ...
- 2018-08-03 16:48北纬32.6的博客 此前翻译的UglifyJS2中文文档已挪到本项目UglifyJS2分支。 喜欢的话请收藏、给个赞/star吧!谢谢! 转载请注明原文链接(https://github.com/LiPinghai/UglifyJSDocCN/blob/master/README.md )与作者信息。 ...
- 2022-10-08 18:31牛老师讲GIS的博客 添加执行命令 { ..., "scripts": { "server:dev": "node ./app.js", "server": "pm2 start ./app.js", "lib:dev": "rollup -wc ./config/rollup.config.dev.js", "lib": "rollup -c ./config/rollup.config.js", ...
- 2019-08-29 17:505. **丰富的插件支持**:通过插件机制,CodeDoc 可以扩展其功能,比如添加代码高亮、搜索功能,或者与其他工具(如 JSDoc、TSDoc)集成。 6. **命令行界面**:提供命令行工具,使得操作更为便捷,只需一行命令即可...
- 2025-03-02 15:38无畏@的博客 Yolo prompt:设置prompt告诉cursor哪些命令可以自动执行不需要询问,此处不配置,可以配置下面的两个 Command allowlist:命令白名单,既可以自动执行的命令,如设置的python、docker等 Command denylist:命令黑...
- 没有解决我的问题, 去提问