注释文档提取器
从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
## 索引
生成可搜索的文档索引:
- 用于快速查找的符号名称
- 类型分类(函数、类、方法)
- 文档完整性指标
- 示例、参数和返回类型计数
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]