# Docstring-Extraktor Extrahiert und analysiert Dokumentation aus JavaScript/TypeScript-, Python- und Java-Quellcode > Kanonische Seite: https://elysiatools.com/de/tools/docstring-extractor - **Kategorie:** Development - **Schlagwörter:** dokumentation, docstring, jsdoc, javadoc, python, javascript, typescript, java, parser, kommentare ## Überblick ## 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 ## Eingaben - **Quellcode** (textarea): Fügen Sie Ihren Quellcode hier ein, um Dokumentation zu extrahieren... - **Programmiersprache** (select) - **Vollständigen Dokumentationstext Einfügen** (checkbox): Vollständige ursprüngliche Dokumentationskommentare einschließen ## 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. ## Funktionsweise - 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. ## Häufig gestellte Fragen ### 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. ## Ähnliche Tools - [Changelog-Extraktor](https://elysiatools.com/de/tools/changelog-extractor): Analysiert und extrahiert strukturierte Daten aus Changelogs und Versionshinweisen in verschiedenen Formaten - [User-Agent-Parser](https://elysiatools.com/de/tools/new-user-agent-parser): Analysiert User-Agent-Strings, um Browser-, BS-, Geräte- und Engine-Informationen zu extrahieren - [URL-Parameter-Extraktor](https://elysiatools.com/de/tools/url-parameter-extractor): Parameter aus URLs extrahieren und analysieren, einschließlich Abfragezeichenketten, Hash-Fragmenten und Pfadsegmenten - [User-Agent-Parser](https://elysiatools.com/de/tools/user-agent-parser): Analysiert User-Agent-Strings, um Browser-, Betriebssystem-, Geräte- und Engine-Informationen zu extrahieren - [Massen-E-Mail-Extraktor](https://elysiatools.com/de/tools/bulk-email-extractor): Extrahieren Sie alle E-Mail-Adressen aus Eingabetext, Artikeln, Web-Quellcode oder gemischtem Inhalt. Unterstützt Deduplizierung und Export nach JSON. - [Datums-Extraktor](https://elysiatools.com/de/tools/date-extractor): Extrahiert Daten aus Text in mehreren Formaten einschließlich chinesisch, ISO und US-Format mit detaillierter Analyse - [JavaScript-Deobfuskator](https://elysiatools.com/de/tools/javascript-deobfuscator): Deobfuskiert und analysiert verschleierten JavaScript-Code zur Verbesserung der Lesbarkeit und Verständlichkeit - [HTML-Attribut-Extraktor](https://elysiatools.com/de/tools/html-attribute-extractor): Extrahiert angegebene Attribute (href, src, data-*, etc.) aus HTML-Inhalten mit Unterstützung für Tag-Name-Filterung ## Beispiele - [Änderungsprotokoll-Extraktor-Beispiele](https://elysiatools.com/de/samples/changelog-extractor): Verschiedene Änderungsprotokollformate zum Testen von Pars- und Extraktionswerkzeugen - [Markdown-Link-Extraktor-Beispiele](https://elysiatools.com/de/samples/markdown-with-links): Markdown-Beispieldokumente mit verschiedenen Linktypen zum Testen des Markdown-Link-Extraktor-Tools - [Telefonnummern-Extraktor Beispiele](https://elysiatools.com/de/samples/phone-number-extractor): Sammlung von gemischtem Text mit Telefonnummern aus verschiedenen Ländern für Extraktionstests - [Web Python Bildverarbeitung Beispiele](https://elysiatools.com/de/samples/web-image-processing-python): Web Python Bildverarbeitungsbeispiele mit PIL/Pillow einschließlich Lesen, Speichern, Skalieren und Formatkonvertierung ## Verwandte Inhalte - [Werkzeuge fur Dokumentations-Authoring, Extraktion und Publishing](https://elysiatools.com/de/hubs/documentation-authoring-publishing): Erstellen Sie Dokumentation, extrahieren Sie Inhalte aus Code oder PDFs, prufen Sie Markdown und exportieren Sie saubere Ergebnisse in einem Dokumentations-Hub. - [Textfall-, Encoding- und Normalisierungs-Konvertierungs-Tools](https://elysiatools.com/de/hubs/text-convert): Vergleichen Sie Textfall-Konvertierung, Zeichenbreiten-Konvertierung, Encoding-Konvertierung, Quoted-Printable-Verarbeitung und Inline-Textnormalisierung in einem Hub. - [Text-Tools](https://elysiatools.com/de/hubs/text-utility): Entdecken Sie 33 text-Tools für utility-Workflows und vergleichen Sie ähnliche Utilities schnell. - [Textanalyse-, Lesbarkeits- und Inhaltsinspektions-Tools](https://elysiatools.com/de/hubs/text-analyze): Vergleichen Sie Textstatistik, Spracherkennung, Lesbarkeitsbewertung, Sentimentanalyse, Moderationsprüfung und Musteranalyse in einem Hub.