💻 Coding Einsteiger Empfohlen

Code-Dokumentations-Generator

Generiert umfassende Dokumentation für bestehenden Code.

Prompt — klicken zum Bearbeiten
Dokumentiere den folgenden Code umfassend:

```[SPRACHE]
[CODE HIER EINFÜGEN]
```

Erstelle:
1. **ÜBERSICHT**: Was macht dieser Code? (2-3 Sätze)

2. **FUNKTIONSDOKUMENTATION**: Für jede Funktion/Methode:
   - Beschreibung
   - Parameter (Name, Typ, Beschreibung)
   - Rückgabewert
   - Exceptions/Fehler
   - Beispielaufruf

3. **ARCHITEKTUR**: Wie hängen die Komponenten zusammen?

4. **DEPENDENCIES**: Welche externen Abhängigkeiten werden genutzt?

5. **SETUP**: Wie wird der Code eingerichtet/gestartet?

6. **BEISPIELE**: 2-3 Anwendungsbeispiele

7. **BEKANNTE LIMITIERUNGEN**

Format: Markdown mit Code-Blöcken.
Sprache: [Deutsch/Englisch]
Stil: [Kurz und knapp / Ausführlich mit Beispielen]

Tipps

Füge den vollständigen Code ein, nicht nur Ausschnitte - Kontext ist wichtig.

Erwartetes Ergebnis

Umfassende Markdown-Dokumentation mit Beispielen.

Anwendungsfall

Code-Dokumentation und Wissenstransfer

345 Aufrufe 189 Kopien