懂AI
jsdoc-to-markdown

jsdoc-to-markdown

自动将JSDoc注释生成Markdown格式API文档的工具

jsdoc-to-markdown是一个将JSDoc注释转换为Markdown格式API文档的开源工具。它可从注释中提取函数签名、参数列表和返回值描述，生成格式清晰的Markdown文档。这个工具主要用于自动化API文档生成，简化了开发者在项目README中添加API文档的过程。通过简单的命令行操作，jsdoc-to-markdown能够快速生成标准化的API文档，提高了文档维护效率。

jsdoc-to-markdownAPI文档生成JavaScriptMarkdown源代码注释Github开源项目
访问官网GitHub文档

在 npm 上查看 npm 模块下载量 Github 仓库依赖项 Github 包依赖项 Node.js CI js-standard-style

jsdoc-to-markdown

升级用户请阅读发布说明

jsdoc-to-markdown

从带有 jsdoc 注释的源代码生成 markdown 格式的 API 文档。适用于将 API 文档注入到项目的 README 文件中。

概要

1. 使用有效的 jsdoc 注释来编写代码文档。

/**
 * 一个非常棒的函数。
 * @param {object} - 隐私斗篷
 * @param {object} - 安全武器
 * @returns {survival}
 */
function protection (cloak, dagger) {}

2. 运行命令。

$ jsdoc2md example.js

3. 获得 markdown 输出。

## protection(cloak, dagger) ⇒ <code>survival</code>
一个非常棒的函数。

**类型**: 全局函数

| 参数   | 类型                | 描述       |
| ------ | ------------------- | ---------- |
| cloak  | <code>object</code> | 隐私斗篷   |
| dagger | <code>object</code> | 安全武器   |

安装

$ npm install --save-dev jsdoc-to-markdown

另请参阅

  • API 文档
  • wiki 包含示例输出、常见问题、教程、插件、与 gulp/grunt 等工具的集成使用等内容。

© 2014-24 Lloyd Brookes <75pound@gmail.com>。

由 test-runner 进行测试。

编辑推荐精选

商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon，您的AI智能助手，致力于通过先进的人工智能技术，为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答，小浣熊都能以快速、准确的响应满足您的需求，让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体，能根据人类指令，自主思考、自主完成、并且交付结果的AI智能体。

Keevx

Keevx

AI数字人视频创作平台

Keevx 一款开箱即用的AI数字人视频创作平台，广泛适用于电商广告、企业培训与社媒宣传，让全球企业与个人创作者无需拍摄剪辑，就能快速生成多语言、高质量的专业视频。

即梦AI

即梦AI

一站式AI创作平台

提供 AI 驱动的图片、视频生成及数字人等功能，助力创意创作

扣子-AI办公

扣子-AI办公

AI办公助手，复杂任务高效处理

AI办公助手，复杂任务高效处理。办公效率低？扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作，覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应，生活工作无缝切换，提升50%效率！

TRAE编程

TRAE编程

AI辅助编程，代码自动修复

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手，一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台，涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能，助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手，随时解答生活与工作的多样问题

问小白，由元石科技研发的AI智能助手，快速准确地解答各种生活和工作问题，包括但不限于搜索、规划和社交互动，帮助用户在日常生活中提高效率，轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
下拉加载更多