Hilfreiche Kommentare für bestehenden Code

Prompt für hilfreiche Kommentare und Funktionsbeschreibungen in bestehendem Code, ohne Logik oder Namen zu ändern. Kopiere ihn in ein KI-Tool deiner Wahl, das dann kommentiert den Code.

Thema: Code verstehen
Art: Prompt
Niveau: Einsteiger
Zeit: ca. 5 Min.

Ergebnisse hängen vom Tool, vom Modell und von deinen Angaben ab.

Ergebnis-Vorschau

Beispiel: von unserer Redaktion geschrieben, keine echte KI-Ausgabe.

def netto_preis(brutto, satz): """Rechnet einen Bruttopreis in den Nettopreis um. brutto: Preis inklusive Steuer, als Dezimalzahl. satz: Steuersatz als Bruchteil, z. B. 0.19. Gibt den Nettopreis auf zwei Stellen gerundet zurück. """ # Erst runden, wenn alles gerechnet ist, damit sich Rundungsfehler nicht addieren. return round(brutto / (1 + satz), 2) Prüfen: Was passiert bei satz = -1?

Ausfüllen

Deine Eingaben bleiben in diesem Browserfenster. Wir speichern und übertragen nichts.

SpracheIn welcher Sprache ist der Code?

LeserWer liest den Code später?

CodeFüge den Code ein – keine Schlüssel oder Kundendaten

Dein Prompt

Schreibe hilfreiche Kommentare und Funktionsbeschreibungen für den folgenden Code.
Sprache: [Sprache]
Wer den Code später liest: [Leser]
Code:
<code>
[Code]
</code>
Regeln: 1. Beschreibe zu jeder Funktion in einem bis drei Sätzen, was sie tut, welche Eingaben sie erwartet und was sie zurückgibt. 2. Kommentiere im Code nur Stellen, an denen das Warum nicht offensichtlich ist. 3. Wiederhole nicht, was der Code ohnehin sagt. 4. Markiere Annahmen und Grenzfälle, die dir auffallen, mit „Prüfen:“. 5. Ändere keine Logik und keine Namen. Nutze den üblichen Kommentarstil der Sprache. Gib den kommentierten Code zurück und darunter eine Liste der Prüfen-Punkte.

Achte besonders darauf, das Warum zu erklären statt den Code nachzuerzählen und weder Logik noch Namen zu ändern.

Prüfe vor deiner Antwort: Sind alle Vorgaben erfüllt? Fehlt eine wichtige Angabe oder steht noch ein Platzhalter in eckigen Klammern im Text, frag nach, statt zu raten. Kennzeichne Annahmen als solche.

Das ist eine Anleitung für eine KI, noch nicht das Ergebnis.

Damit funktioniert der Prompt

Diese KI-Tools eignen sich für diesen Prompt:

So gehst du vor

Fülle die Felder aus oder tippe auf einen Vorschlag. Lass Namen, Adressen und andere persönliche Daten weg.
Kopiere den fertigen Prompt in ein KI-Tool deiner Wahl.
Lies die Kommentare gegen und kläre die Prüfen-Punkte, bevor du sie übernimmst.

Warum funktioniert das?

Kommentare, die das Warum erklären, bleiben auch nach Änderungen nützlich. Die Regel, keine Logik zu ändern, hält die Änderung klein und leicht zu prüfen.

Tipps

Lass sensible Werte wie Schlüssel oder Passwörter vor dem Einfügen weg oder ersetze sie durch Platzhalter.

Du darfst unsere Prompts frei nutzen, auch beruflich. Bitte veröffentliche sie nicht als eigene Sammlung. Für KI-Ergebnisse übernehmen wir keine Gewähr; prüfe sie selbst. Nutzungsbedingungen

Hilfreiche Kommentare für bestehenden Code

Ergebnis-Vorschau

Ausfüllen

Dein Prompt

Damit funktioniert der Prompt

So gehst du vor

Warum funktioniert das?

Tipps

Passt auch zu

Unbekannten Code erklären Neu

Große Änderung in prüfbare Commits aufteilen Neu

Cron-Zeitplan aus einer Beschreibung Neu