Kategorien

← View All Tools

Kommentare zu PDF

Erstellt PDF-API-Dokumentation aus Kommentaren

Extrahiert JSDoc-Kommentare und erzeugt ein PDF.

Eingabe: Code mit /** */
Ausgabe: PDF

Beispielergebnisse

1 Beispiele

Beispiel: Doc Comment Docs

Automatisch erzeugtes PDF-Beispiel: Source comments rendered as docs PDF

doc-comment-to-pdf-docs-example1.pdf Datei anzeigen
Eingabeparameter anzeigen
{ "sourceText": "/**\n * Adds two values\n * @param {number} a\n * @param {number} b\n */\nfunction add(a,b){ return a+b }", "docTitle": "Utility Docs", "version": "1.0.0" }

Click to upload file or drag and drop file here

Maximum file size: 10MB Supported formats: text/plain, application/octet-stream

Wichtige Fakten

Kategorie
Document Tools
Eingabetypen
textarea, file, text, number, select, checkbox
Ausgabetyp
file
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Verwandeln Sie Ihren Quellcode effizient in professionelle API-Dokumentationen. Dieses Tool extrahiert JSDoc-Kommentare direkt aus Ihrem Code und konvertiert sie in ein strukturiertes, druckfertiges PDF-Dokument.

Wann verwenden

  • •Wenn Sie schnell eine API-Referenz aus bestehenden JSDoc-Kommentaren erstellen müssen.
  • •Wenn Sie eine übersichtliche PDF-Dokumentation für interne Projekte oder Kunden benötigen.
  • •Wenn Sie Code-Dokumentation ohne komplexe Build-Pipelines in ein lesbares Format bringen wollen.

So funktioniert es

  • •Geben Sie Ihren Quellcode mit JSDoc-Kommentaren direkt in das Textfeld ein oder laden Sie eine Quelldatei hoch.
  • •Passen Sie bei Bedarf den Dokumenttitel, die Version und das Seitenlayout an.
  • •Starten Sie den Prozess, um die JSDoc-Inhalte zu parsen und das PDF-Dokument zu generieren.
  • •Laden Sie die fertige PDF-Datei herunter, die Ihre API-Struktur übersichtlich darstellt.

Anwendungsfälle

Erstellung von API-Handbüchern für Entwicklerteams.
Automatisierte Dokumentation von Funktionsbibliotheken für die Projektabgabe.
Schnelle Erstellung von Referenzblättern für interne Software-Schnittstellen.

Beispiele

1. API-Dokumentation für eine Utility-Bibliothek

Softwareentwickler
Hintergrund
Ein Entwickler hat eine neue JavaScript-Bibliothek geschrieben und möchte diese für das Team dokumentieren.
Problem
Die manuelle Erstellung einer PDF-Dokumentation aus den Kommentaren ist zu zeitaufwendig.
Verwendung
Den Quellcode in das Textfeld kopieren, einen Titel vergeben und die Seitengröße auf A4 festlegen.
Beispielkonfiguration
docTitle: 'Utility Lib API', pageSize: 'A4', baseFontSize: 12
Ergebnis
Ein professionelles PDF, das alle Funktionen und Parameter der Bibliothek übersichtlich auflistet.

Mit Samples testen

pdf, text, file
PDF-Beispiele
Generierte PDF-Beispiele von Tools zwischen 2026-02-01 und 2026-02-10
title token pdf
text
Code-Kommentar-Beispiele
Code-Beispieldateien mit verschiedenen Kommentarstilen zum Testen der Kommentarentfernung
title token comment
text
Markdown Foliensatz Beispiele
Remark/Marp Markdown Decks zum Testen des PDF Exports
preferred input family text
text
Code-Dokumentationsbeispiele
Codebeispiele mit verschiedenen Dokumentationsstilen, einschließlich JSDoc, JavaDoc, Python-Docstrings und TypeScript-Annotationen
preferred input family text
text

Verwandte Hubs

Pdf-Convert-Tools
Entdecken Sie 28 pdf-Tools für convert-Workflows und vergleichen Sie ähnliche Utilities schnell.
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.

FAQ

Welche Kommentarformate werden unterstützt?

Das Tool ist auf JSDoc-konforme Kommentare optimiert, die mit /** beginnen und */ enden.

Kann ich das Layout der PDF anpassen?

Ja, Sie können Seitengröße, Ausrichtung (Querformat), Ränder und die Schriftgröße individuell konfigurieren.

Ist die Nutzung sicher?

Die Verarbeitung erfolgt direkt. Ihre hochgeladenen Quelldateien werden nicht dauerhaft gespeichert.

Welche Dateiformate kann ich hochladen?

Sie können Textdateien oder allgemeine Quelldateien hochladen, die JSDoc-Kommentare enthalten.

Wie groß darf die Quelldatei sein?

Die maximale Dateigröße für Uploads beträgt 10 MB.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/doc-comment-to-pdf-docs

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
sourceText textarea Nein -
sourceFile file (Upload erforderlich) Nein -
docTitle text Nein -
version text Nein -
baseFontSize number Nein -
pageSize select Nein -
landscape checkbox Nein -
printBackground checkbox Nein -
marginTop number Nein -
marginBottom number Nein -
marginLeft number Nein -
marginRight number Nein -
waitUntil select Nein -
waitTime number Nein -

Dateitypparameter müssen erst über POST /upload/doc-comment-to-pdf-docs hochgeladen werden, um filePath zu erhalten, dann filePath an das entsprechende Dateifeld übergeben.

Antwortformat

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Datei: Datei

MCP-Dokumentation

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

{
  "mcpServers": {
    "elysiatools-doc-comment-to-pdf-docs": {
      "name": "doc-comment-to-pdf-docs",
      "description": "Erstellt PDF-API-Dokumentation aus Kommentaren",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=doc-comment-to-pdf-docs",
      "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.

Unterstützt URL-Dateilinks oder Base64-Codierung für Dateiparameter.

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