Elysia Tools
Navigation
Development
Extract and parse documentation from JavaScript/TypeScript, Python, and Java source code
Details
Extract documentation from multiple programming languages:
Extracts complete documentation metadata:
Parses common documentation patterns:
/** ... */ with @param, @return, @throws"""...""" with Args, Returns, Raises sections/** ... */ with @param, @return, @throwsGenerates searchable documentation index:
Execution
Fill in the form, run the tool, and review the result in one place.
Samples
Related
Ready for a run
Tool usage guide
The Docstring Extractor is a tool that automatically extracts and parses documentation comments from source code in JavaScript, TypeScript, Python, and Java. It supports JSDoc, Python docstrings, and JavaDoc formats, outputting structured JSON with metadata like function names, parameters, and return types for easy integration into documentation workflows.
Background
A developer has a JavaScript file with JSDoc comments describing functions for a web application.
Problem
Manually copying documentation for API reference is tedious and prone to errors.
How to use
Paste the JavaScript code into the tool and select 'JavaScript' as the language hint.
Outcome
A JSON object with extracted function names, @param tags, @return descriptions, and line numbers for quick reference.
Background
A Python project contains functions with triple-quoted docstrings outlining Args, Returns, and Raises sections.
Problem
Need to generate a structured API reference without manually parsing each docstring.
How to use
Input the Python source code and let the tool auto-detect the language to extract documentation.
Outcome
JSON output with parsed parameters, return types, and exception details, ready for documentation generation.
JavaScript, TypeScript, Python, and Java.
JSDoc for JavaScript/TypeScript, triple-quoted docstrings for Python, and JavaDoc for Java.
Yes, use auto-detect or specify the language hint for accurate parsing.
Function/class names, descriptions, parameters, return values, exceptions, examples, line numbers, and visibility.
You can choose to include the full original documentation text via a checkbox option.
Background
A Java codebase has classes with JavaDoc comments that include @param, @return, and @throws tags.
Problem
Assessing documentation coverage across methods to identify gaps in the project.
How to use
Upload the Java source files and extract metadata to review documented symbols.
Outcome
Insights into documented methods, parameters, and exceptions, with visibility and completeness metrics in JSON format.