分类

← View All Tools

注释生成PDF文档

从代码注释生成API文档PDF

解析JSDoc风格注释并生成API文档PDF。

输入： 包含 /** */ 的源码
输出： PDF文档

示例结果

1 个示例

示例：Doc Comment Docs

自动生成的PDF样例：Source comments rendered as docs PDF

doc-comment-to-pdf-docs-example1.pdf 查看文件
查看输入参数
{ "sourceText": "/**\n * Adds two values\n * @param {number} a\n * @param {number} b\n */\nfunction add(a,b){ return a+b }", "docTitle": "Utility Docs", "version": "1.0.0" }

Click to upload file or drag and drop file here

Maximum file size: 10MB Supported formats: text/plain, application/octet-stream

关键信息

分类
Document Tools
输入类型
textarea, file, text, number, select, checkbox
输出类型
file
样本覆盖
4
支持 API
Yes

概览

这款工具能够快速解析源码中的 JSDoc 风格注释，并将其自动转换为格式规范的 API 文档 PDF，帮助开发者高效完成项目文档的归档与分享。

适用场景

  • •需要为项目快速生成专业的 API 参考手册时
  • •在交付代码前，需要将代码注释整理为可读的 PDF 文档时
  • •需要将分散的代码注释统一归档，以便团队内部查阅时

工作原理

  • •输入包含 JSDoc 风格注释（/** */）的源码文本或上传源码文件。
  • •根据需求设置文档标题、版本号以及页面布局参数。
  • •点击转换按钮，系统将自动解析注释内容并生成 PDF 文档。
  • •下载生成的 PDF 文件，即可获得结构清晰的 API 文档。

使用场景

为开源项目快速生成 API 使用说明书
将内部开发接口文档化，方便跨部门协作
自动化生成项目版本迭代的 API 变更记录

用户案例

1. 生成项目 API 参考手册

前端开发工程师
背景原因
项目即将上线，需要为团队提供一份包含所有核心函数说明的 API 文档。
解决问题
手动编写文档耗时且容易与代码逻辑脱节。
如何使用
将包含 JSDoc 注释的源码粘贴至输入框，设置文档标题为“用户模块 API”，点击生成。
示例配置
docTitle: 用户模块 API, version: 1.0.0, pageSize: A4
效果
获得一份格式整洁、包含函数参数与功能说明的 PDF 文档。

用 Samples 测试

pdf, text, file
PDF示例
2026-02-01 到 2026-02-10 工具生成的PDF示例
title token pdf
text
代码注释示例
用于测试注释移除的各种注释样式代码示例文件
title token comment
text
Markdown 幻灯片示例
用于测试 PDF 导出的 Remark/Marp 风格 Markdown 幻灯片
preferred input family text
text
代码文档样本
包含各种文档风格的代码示例，包括JSDoc、JavaDoc、Python文档字符串和TypeScript注释
preferred input family text
text

相关专题

PdfConvert工具专题
探索 28 个围绕 pdf 的 convert 工作流工具，快速找到相近能力。
TextConvert工具专题
探索 80 个围绕 text 的 convert 工作流工具，快速找到相近能力。
Text 工具专题
探索 33 个围绕 text 的 utility 工作流工具，快速找到相近能力。
TextAnalyze工具专题
探索 12 个围绕 text 的 analyze 工作流工具，快速找到相近能力。

常见问题

该工具支持哪些注释格式？

该工具主要解析标准的 JSDoc 风格注释（即以 /** 开头，以 */ 结尾的注释块）。

生成的 PDF 文档可以自定义样式吗？

您可以调整基础字号、页面尺寸、横向/纵向布局以及页边距等参数来满足基本的排版需求。

上传源码文件有大小限制吗？

是的，上传的源码文件大小限制为 10MB。

我可以自定义生成的文档标题吗？

可以，您可以在配置项中输入自定义的文档标题和版本号，这些信息会显示在生成的 PDF 中。

如果代码中有复杂的依赖，转换会失败吗？

该工具专注于解析注释内容，只要源码中包含符合规范的 JSDoc 注释，即可正常提取并生成文档。

API 文档

请求端点

POST /zh/api/tools/doc-comment-to-pdf-docs

请求参数

参数名 类型 必填 描述
sourceText textarea 否 -
sourceFile file (需要先上传) 否 -
docTitle text 否 -
version text 否 -
baseFontSize number 否 -
pageSize select 否 -
landscape checkbox 否 -
printBackground checkbox 否 -
marginTop number 否 -
marginBottom number 否 -
marginLeft number 否 -
marginRight number 否 -
waitUntil select 否 -
waitTime number 否 -

文件类型参数需要先通过 POST /upload/doc-comment-to-pdf-docs 上传获取 filePath，然后将 filePath 传递给对应的文件字段。

响应格式

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
文件: 文件

AI MCP 文档

将此工具添加到您的 MCP 服务器配置中： 

{
  "mcpServers": {
    "elysiatools-doc-comment-to-pdf-docs": {
      "name": "doc-comment-to-pdf-docs",
      "description": "从代码注释生成API文档PDF",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=doc-comment-to-pdf-docs",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

你可以串联多个工具，比如：`https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`，最多20个。

支持 URL 文件链接或 Base64 编码作为文件参数。

如果遇见问题，请联系我们：[email protected]