分类

← View All Tools

注释文档提取器

从JavaScript/TypeScript、Python和Java源代码中提取和解析文档

功能

从多种编程语言中提取文档：

  • JSDoc: JavaScript和TypeScript文档注释
  • Python文档字符串: 三引号函数和类文档
  • JavaDoc: 带有标准标签的Java文档注释

提取

提取完整的文档元数据：

  • 函数/类名称: 符号标识符
  • 描述: 主要文档文本
  • 参数: 带有名称、类型和描述的@param标签
  • 返回值: @return或@returns标签
  • 异常: @throws、@exception或raises部分
  • 示例: @example标签或示例代码块
  • 行号: 源代码中的位置
  • 可见性: 公共、私有或受保护成员

解析

解析常见的文档模式：

  • JSDoc: /** ... */ 带@param、@return、@throws
  • Python: """...""" 带Args、Returns、Raises部分
  • JavaDoc: /** ... */ 带@param、@return、@throws

索引

生成可搜索的文档索引：

  • 用于快速查找的符号名称
  • 类型分类（函数、类、方法）
  • 文档完整性指标
  • 示例、参数和返回类型计数

包含完整的原始文档注释

关键信息

分类
Development
输入类型
textarea, select, checkbox
输出类型
json
样本覆盖
4
支持 API
Yes

概览

注释文档提取器是一款专为开发者设计的工具，能够从 JavaScript/TypeScript、Python 和 Java 源代码中自动提取并解析文档注释。它支持 JSDoc、Python 文档字符串和 JavaDoc 格式，可提取函数/类名称、描述、参数、返回值、异常、示例等完整元数据，并生成可搜索的文档索引，极大提升代码文档的处理效率。

适用场景

  • •需要从现有代码库中批量提取函数或类的文档注释，用于生成 API 文档或知识库时。
  • •在代码审查或交接过程中，需要快速了解某个函数或类的用途、参数和返回值时。
  • •希望检查代码中文档注释的完整性，例如是否缺少参数描述或返回值说明时。

工作原理

  • •将包含文档注释的源代码粘贴到输入框中。
  • •选择编程语言（或使用自动检测功能）。
  • •工具将解析代码，识别并提取所有符合规范的文档注释块。
  • •输出结构化的 JSON 数据，包含提取到的所有文档元数据。

使用场景

自动生成项目 API 参考文档，将提取的文档数据导入到文档生成工具中。
进行代码审查时，快速提取并查看相关函数的完整文档，辅助理解代码逻辑。
为缺乏文档的遗留代码项目，快速梳理和补充基础文档信息。

用户案例

1. 提取 React 组件文档

前端开发者
背景原因
开发者正在维护一个 React 组件库，需要为每个组件生成使用说明文档。
解决问题
手动从多个 JSX/TSX 文件中复制粘贴 JSDoc 注释效率低下且容易出错。
如何使用
将组件源代码粘贴到输入框，语言选择“JavaScript”或“TypeScript”。
示例配置
languageHint: "typescript"
效果
工具提取出组件的 props（参数）、描述和示例，生成的 JSON 数据可直接用于文档网站的构建。

2. 整理 Python 模块函数说明

Python 开发者
背景原因
开发者编写了一个数据处理模块，其中包含多个带有详细文档字符串的函数。
解决问题
需要一份清晰的函数列表，包含每个函数的功能、参数和返回值说明，以便团队其他成员查阅。
如何使用
将整个 Python 模块文件内容粘贴到输入框，语言选择“Python”。
效果
工具解析所有函数和类的文档字符串，输出结构化的 JSON，清晰地列出了每个函数的 Args、Returns 和 Raises 部分。

用 Samples 测试

text
Markdown 链接提取示例
包含各种链接类型的 Markdown 示例文档，用于测试 Markdown 链接提取工具
title token extractor
text
变更日志提取器样本
用于测试变更日志解析和提取工具的各种变更日志格式
title token extractor
text
手机号提取器示例
包含来自多个国家的电话号码的混合文本集合，用于提取测试
title token extractor
text
代码文档样本
包含各种文档风格的代码示例，包括JSDoc、JavaDoc、Python文档字符串和TypeScript注释
matched family text
text

相关专题

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

常见问题

这个工具支持哪些编程语言？

目前支持 JavaScript、TypeScript、Python 和 Java。

能提取哪些文档信息？

可以提取函数/类名、描述、参数（@param）、返回值（@return）、异常（@throws）、示例（@example）以及行号和可见性等信息。

如何使用这个工具？

只需将源代码粘贴到输入框，选择或自动检测编程语言，然后点击提取即可获得结构化的文档数据。

输出结果是什么格式？

输出为结构化的 JSON 格式，便于程序进一步处理或集成到其他文档系统中。

可以上传代码文件吗？

目前仅支持直接粘贴源代码文本，不支持文件上传功能。

API 文档

请求端点

POST /zh/api/tools/docstring-extractor

请求参数

参数名 类型 必填 描述
codeInput textarea 是 -
languageHint select 否 -
includeFullText checkbox 否 包含完整的原始文档注释

响应格式

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
JSON数据: JSON数据

AI MCP 文档

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

{
  "mcpServers": {
    "elysiatools-docstring-extractor": {
      "name": "docstring-extractor",
      "description": "从JavaScript/TypeScript、Python和Java源代码中提取和解析文档",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

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

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