Kategorien

← View All Tools

Docstring-Extraktor

Extrahiert und analysiert Dokumentation aus JavaScript/TypeScript-, Python- und Java-Quellcode

Funktionen

Extrahiert Dokumentation aus mehreren Programmiersprachen:

  • JSDoc: JavaScript- und TypeScript-Dokumentationskommentare
  • Python-Docstrings: Funktions- und Klassendokumentation in dreifachen Anführungszeichen
  • JavaDoc: Java-Dokumentationskommentare mit Standard-Tags

Extraktion

Extrahiert vollständige Dokumentationsmetadaten:

  • Funktions-/Klassennamen: Symbol-Identifikatoren
  • Beschreibungen: Hauptdokumentationstext
  • Parameter: @param-Tags mit Namen, Typen und Beschreibungen
  • Rückgabewerte: @return- oder @returns-Tags
  • Ausnahmen: @throws-, @exception-Tags oder Raises-Abschnitte
  • Beispiele: @example-Tags oder Beispielcodeblöcke
  • Zeilennummern: Position im Quellcode
  • Sichtbarkeit: Öffentliche, private oder geschützte Mitglieder

Analyse

Analysiert gängige Dokumentationsmuster:

  • JSDoc: /** ... */ mit @param, @return, @throws
  • Python: """...""" mit Args-, Returns-, Raises-Abschnitten
  • JavaDoc: /** ... */ mit @param, @return, @throws

Index

Erstellt ein durchsuchbares Dokumentations-Index:

  • Symbolnamen für schnelle Suche
  • Kategorisierung nach Typ (Funktionen, Klassen, Methoden)
  • Metriken zur Dokumentationsvollständigkeit
  • Zählung von Beispielen, Parametern und Rückgabetypen

Vollständige ursprüngliche Dokumentationskommentare einschließen

Wichtige Fakten

Kategorie
Development
Eingabetypen
textarea, select, checkbox
Ausgabetyp
json
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der Docstring-Extraktor ist ein Online-Werkzeug, das Dokumentationskommentare aus Quellcode in JavaScript, TypeScript, Python und Java automatisch extrahiert und analysiert. Es erkennt JSDoc-, Python-Docstring- und JavaDoc-Formate und stellt strukturierte Metadaten wie Funktionsnamen, Parameter und Rückgabewerte im JSON-Format bereit.

Wann verwenden

  • •Wenn Sie automatisch API-Dokumentation aus vorhandenem Code generieren möchten.
  • •Bei der Überprüfung der Dokumentationsvollständigkeit in Softwareprojekten.
  • •Um schnell Funktionen und Klassen in einer großen Codebasis zu finden und zu verstehen.

So funktioniert es

  • •Fügen Sie Ihren Quellcode in das Textfeld ein.
  • •Wählen Sie die Programmiersprache manuell aus oder nutzen Sie die automatische Erkennung.
  • •Konfigurieren Sie optional, ob der vollständige Dokumentationstext einbezogen werden soll.
  • •Starten Sie die Extraktion, um strukturierte Dokumentationsmetadaten als JSON zu erhalten.

Anwendungsfälle

Automatische Generierung von OpenAPI-Dokumentation aus JSDoc-Kommentaren in JavaScript-Projekten.
Analyse der Dokumentationsabdeckung in Python-Modulen zur Verbesserung der Codequalität.
Erstellung eines durchsuchbaren Index für Java-Klassen und Methoden in Entwicklerteams.

Beispiele

1. JSDoc-Extraktion für ein Node.js-Modul

Hintergrund
Ein Entwickler arbeitet an einem Node.js-Modul mit umfangreichen JSDoc-Kommentaren in TypeScript.
Problem
Er benötigt eine strukturierte Übersicht aller Funktionen, Parameter und Rückgabetypen für die automatische Dokumentationsgenerierung.
Verwendung
Kopiert den TypeScript-Code in das Eingabefeld und wählt 'TypeScript' als Sprache aus.
Beispielkonfiguration
Aktiviert die Option 'Vollständigen Dokumentationstext Einfügen', um die Originalkommentare beizubehalten.
Ergebnis
Erhält ein JSON mit allen Funktionen, @param- und @return-Tags, das direkt in ein Doku-Tool wie Swagger importiert werden kann.

2. Python-Docstring-Analyse für eine Flask-API

Hintergrund
Ein Team entwickelt eine Flask-API mit Python-Docstrings in dreifachen Anführungszeichen.
Problem
Sie wollen die Vollständigkeit der Dokumentation überprüfen, um sicherzustellen, dass alle Endpunkte korrekt beschrieben sind.
Verwendung
Lädt die Python-Datei hoch und lässt die Sprache automatisch erkennen.
Ergebnis
Extrahiert alle Funktions- und Klassendokumentationen, identifiziert fehlende Abschnitte wie 'Raises' und generiert einen Bericht zur Verbesserung.

Mit Samples testen

text
Markdown-Link-Extraktor-Beispiele
Markdown-Beispieldokumente mit verschiedenen Linktypen zum Testen des Markdown-Link-Extraktor-Tools
title token extractor
text
Änderungsprotokoll-Extraktor-Beispiele
Verschiedene Änderungsprotokollformate zum Testen von Pars- und Extraktionswerkzeugen
title token extractor
text
Telefonnummern-Extraktor Beispiele
Sammlung von gemischtem Text mit Telefonnummern aus verschiedenen Ländern für Extraktionstests
title token extractor
text
Code-Dokumentationsbeispiele
Codebeispiele mit verschiedenen Dokumentationsstilen, einschließlich JSDoc, JavaDoc, Python-Docstrings und TypeScript-Annotationen
matched family text
text

Verwandte Hubs

Text-Convert-Tools
Entdecken Sie 80 text-Tools für convert-Workflows und vergleichen Sie ähnliche Utilities schnell.
Text-Tools
Entdecken Sie 33 text-Tools für utility-Workflows und vergleichen Sie ähnliche Utilities schnell.
Text-Analyze-Tools
Entdecken Sie 12 text-Tools für analyze-Workflows und vergleichen Sie ähnliche Utilities schnell.
Text-Format-Tools
Entdecken Sie 9 text-Tools für format-Workflows und vergleichen Sie ähnliche Utilities schnell.

FAQ

Welche Programmiersprachen unterstützt das Tool?

JavaScript, TypeScript, Python und Java.

Wie wird die Sprache des Codes erkannt?

Automatisch anhand des Code-Inhalts oder manuell über eine Auswahl im Dropdown-Menü.

Kann ich den vollständigen Dokumentationstext in den Ergebnissen einbeziehen?

Ja, aktivieren Sie die Option 'Vollständigen Dokumentationstext Einfügen'.

In welchem Format werden die extrahierten Daten ausgegeben?

Als strukturiertes JSON mit Details wie Symbolnamen, Beschreibungen, Parametern und Zeilennummern.

Eignet sich das Tool für große Codebasen?

Ja, es verarbeitet Quellcode effizient, aber sehr große Dateien können die Verarbeitungszeit erhöhen.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/docstring-extractor

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
codeInput textarea Ja -
languageHint select Nein -
includeFullText checkbox Nein Vollständige ursprüngliche Dokumentationskommentare einschließen

Antwortformat

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

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu: 

{
  "mcpServers": {
    "elysiatools-docstring-extractor": {
      "name": "docstring-extractor",
      "description": "Extrahiert und analysiert Dokumentation aus JavaScript/TypeScript-, Python- und Java-Quellcode",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]