Erkläre code: Wie du ein präzises Auftrag für das Werkzeug formulierst
Das Werkzeug „Code-Erklärer“ hilft, die Funktionsweise eines Code-Abschnitts zu verstehen: welche Daten es annimmt, wie es verarbeitet wird und was es zurückgibt. Die Qualität der Antwort hängt von der Genauigkeit der Aufgabenbeschreibung ab. In diesem Artikel gehen wir darauf ein, was Sie in die Eingabe eingeben sollen, geben Beispiele für gelungene und misslungene Formulierungen und zeigen, wie Sie das Ergebnis überprüfen.
Tool öffnen: Code-Erklärer ↗Was ist „Code-Erklärer“ und warum ist ein präziser Auftrag nötig?
„Code-Erklärer“ ist ein Werkzeug, das einen bereitgestellten Code-Ausschnitt analysiert und einen textlichen Ausgabet liefert: welche Eingabedaten es erwartet, wie sie verarbeitet werden und was am Ausgang entsteht. Darüber hinaus kann das Werkzeug auf potenzielle Grenzfälle hinweisen, die überprüft werden sollten. Das ist nützlich, wenn Sie fremden Code untersuchen, schnell eine Lösung anderer verstehen möchten oder sicherstellen wollen, dass Sie die Logik richtig verstanden haben.
Das Werkzeug liest jedoch Ihre Gedanken nicht. Wenn Sie einfach nur Code ohne Erklärungen einfügen, kann es eine allgemeine Beschreibung geben, die wichtige Aspekte nicht berührt. Je präziser Sie die Aufgabe formulieren, desto relevanter wird die Antwort. Wenn Sie beispielsweise an Leistungsfähigkeit oder Fehlerbehandlung interessiert sind, sollten Sie dies extra erwähnen.
Die Eingabe besteht aus zwei Feldern: „Code und Fehlermeldung“ (bis zu 8000 Zeichen) und „Plattform oder Anwendung“ (bis zu 1000 Zeichen). Das erste Feld ist für den eigentlichen Code und bei Bedarf Fehlermeldungstext bestimmt. Das zweite dient zur Angabe von Sprache, Framework oder Umgebung, in der der Code ausgeführt wird. Das Ausfüllen beider Felder erhöht die Genauigkeit der Erklärung.
Schlecht: „Erkläre diesen Code.“ Gut: „Erkläre, was dieser Code in Python macht: values = [x * 2 for x in range(5)]. Beschreibe Eingabedaten, Ausführungsprozess und Ergebnis. Weise darauf hin, was passiert, wenn range(5) durch range(0) ersetzt wird.“
Wie formulierst du einen präzisen Auftrag: Schlüssel Elemente
Um eine nützliche Erklärung zu erhalten, solltest du in der Eingabe mehrere Punkte angeben. Erstens der Kontext: In welcher Programmiersprache ist der Code geschrieben, in welcher Umgebung wird er ausgeführt, gibt es Abhängigkeiten. Diese Informationen können im Feld „Plattform oder Anwendung“ platziert werden. Zweitens das Ziel: Was genau möchtest du verstehen – allgemeine Logik, bestimmte Funktion, Grund eines Fehlers oder Grenzfälle? Drittens Antwortformat: Zum Beispiel „beschreibe Eingabedaten, dann Ausführungsschritte, dann Ergebnis“. Viertens Einschränkungen: Wenn dich nur ein bestimmter Aspekt interessiert, sage dazu.
Es ist nicht notwendig, einen langen Aufsatz zu schreiben. Es reicht einige Sätze, die das Werkzeug leiten. Zum Beispiel: „Dieser Code in JavaScript nimmt ein Zahlenarray entgegen und gibt die Summe zurück. Erkläre, wie der Schleifendurchlauf funktioniert, und weise darauf hin, was passiert, wenn das Array leer ist.“ Solche Anforderung setzt sofort Rahmen.
Wenn du eine Fehlermeldung einfügst, gib an, in welchem Stadium sie auftritt. Das hilft dem Werkzeug, die Fehler mit bestimmten Code-Teilen zu verknüpfen. Einfüge nicht den gesamten Call Stack, wenn er sehr lang ist – beschränke dich auf relevante Zeilen.
Guter Auftrag: „Ich bin Anfänger in Python. Erkläre bitte diesen Code: values = [x * 2 for x in range(5)]. Was wird eingegeben? Was passiert drinnen? Was ist am Ende? Gibt es Fälle, in denen der Code nicht so funktioniert, wie erwartet?“
Beispiel für schlechtes und gutes Auftrag
Ein schlechtes Auftrag sieht oft so aus: „Erkläre Code.“ Das Werkzeug weiß nicht, was genau dich interessiert, und kann eine oberflächliche Beschreibung geben. Noch schlimmer, wenn der Code groß und komplex ist – ohne Zielangabe ist die Antwort diffus. Auch sollte man nicht „Code reparieren“ schreiben, wenn man keinen Fehlermeldungstext angehängt hat und nicht beschrieben hat, was bereits versucht wurde.
Ein guter Auftrag enthält Spezifität. Zum Beispiel: „Dieser Code in Python berechnet die Fakultät einer Zahl. Erkläre, wie die Rekursion funktioniert, und weise darauf hin, was bei einem negativen Argument passiert. Wenn möglich, ein Beispiel für n=5.“ Hier ist Sprache, Ziel, Anfrage nach Grenzfall und Beispiel enthalten.
Ein weiteres gelungenes Beispiel: „Überprüfe dieses Fragment in JavaScript. Es soll das größte Element in einem Array finden. Erkläre, wie es das tut, und weise darauf hin, was passiert, wenn das Array leer ist oder nicht-numerische Werte enthält.“ Solche Anforderung hilft nicht nur, den Code zu verstehen, sondern auch seine Zuverlässigkeit zu bewerten.
Schlecht: „Was ist hier falsch?“ Gut: „Dieser Code in Python soll die Summe gerader Zahlen aus einer Liste zurückgeben. Erkläre, wie er funktioniert, und weise darauf hin, was passiert, wenn in der Liste negative Zahlen oder Zeichenketten sind.“
Wie du das Ergebnis der Erklärung überprüfst
Nachdem das Werkzeug eine Erklärung ausgegeben hat, solltest du nicht voreilig glauben. Vergleiche die Beschreibung mit dem tatsächlichen Verhalten des Codes: Führe ihn auf mehreren Datensätzen aus, einschließlich der von dem Werkzeug erwähnten Grenzfälle. Wenn die Erklärung vom tatsächlichen Ergebnis abweicht, gibt es möglicherweise nicht offensichtliche Details im Code oder das Werkzeug hat etwas übersehen.
Achte auf Eingabe- und Ausgabedaten. Das Werkzeug sollte klar sagen, was als Eingabe dient und was als Ausgabe erhalten wird. Wenn es sagt „transformiert Daten“, bitte um genauere Angabe. Prüfe zudem, ob alle Ausführungswege beschrieben werden: Schleifen, Bedingungen, Ausnahmebehandlung.
Wenn die Erklärung unvollständig erscheint, kann man eine Nachfrage-Frage in einer neuen Anforderung stellen und auf den vorherigen Antwort verweisen. Zum Beispiel: „In der vorherigen Erklärung hast du nicht erwähnt, was passiert, wenn die Datei nicht gefunden wird. Kläre bitte nach.“ Das Werkzeug speichert keine Geschichte, daher muss der Kontext wiederholt werden.
Nach der Erklärung den Code mit leerer Liste, negativen Zahlen und sehr großen Werten ausführen. Vergleiche mit dem, was das Werkzeug vorhergesagt hat.
Einschränkungen des Werkzeugs und typische Fehler
„Code-Erklärer“ führt keinen Code aus und prüft ihn nicht auf Fehler. Er analysiert Text und liefert eine Beschreibung basierend auf Modellen. Deshalb können Unaugenauigkeiten auftreten: Das Werkzeug kann Besonderheiten bestimmter Sprachversionen oder Bibliotheken nicht kennen. Überprüfe kritische Momente bitte immer selbst.
Das Werkzeug ist nicht dazu bestimmt, Code zu generieren oder zu korrigieren. Seine Aufgabe ist die Erklärung. Wenn du aufforderst, „Code besser umzuschreiben“, überschreitest du die Grenzen. Außerdem arbeitet er nicht mit Bildern oder Audio: nur mit Text. Es sollte keine Code-Screenshots eingefügt werden – diese müssen in Text umgewandelt werden.
Ein weiteres Einschränkung: Die maximale Länge des ersten Feldes beträgt 8000 Zeichen. Wenn der Code länger ist, muss er in Teile aufgeteilt oder verkürzt werden. Im zweiten Feld können bis zu 1000 Zeichen angegeben werden. Überschreitung des Limits führt zu einem Fehler. Denke zudem daran, dass Modellantworten Fehler enthalten können und Verfügbarkeit und Warteschlangen sich ändern können.
Nicht fragen: „Mache den Code schneller.“ Stattdessen: „Erkläre, welche Operationen in diesem Code langsam sein können und warum.“
Praktische Empfehlungen zur Formulierung
Beginne mit einer kurzen Beschreibung des Ziels: „Ich muss verstehen, wie dieser Code Eingabedaten verarbeitet.“ Dann den Code einfügen. Danach Hinweise hinzufügen: „Achte auf die while-Schleife und den Exit-Bedingung.“ Falls es einen Fehler gibt, hänge seinen Text an und sage, wann er auftritt.
Verwende das Feld „Plattform oder Anwendung“, um Sprache und Version anzugeben, zum Beispiel „Python 3.9, Standardbibliothek“. Das hilft dem Werkzeug, nicht zu raten. Wenn der Code von externen Bibliothängen abhänge, erwähne deren Namen und Version, wenn du es weißt.
Formuliere die Anforderung so, dass die Antwort strukturiert ist. Zum Beispiel: „Beschreibe Eingabedaten, dann Ausführungsschritte, dann Ausgabedaten. Liste mögliche Grenzfälle separat auf.“ Dann erhältst du einen organisierten Antwort, der leichter zu überprüfen ist.
„Dieser Code in Java nimmt einen String entgegen und gibt seine Länge zurück. Erkläre, wie die Methode length() funktioniert, und was passiert, wenn der String null ist. Plattform: Java 11.“
Ein präziser Auftrag für das Werkzeug „Code-Erklärer“ ist ein Balanceakt zwischen Spezifität und Umfang. Geben Sie die Sprache und Umgebung an, beschreiben Sie genau, was Sie verstehen möchten, und bitten Sie darum, Eingaben, Ausführung und Ausgaben sowie Grenzfälle zu analysieren. Führen Sie Beispiele an, überladen Sie den Auftrag nicht. Nach Erhalt der Erklärung überprüfen Sie diese bitte an echten Daten. Beachten Sie, dass das Werkzeug Code nicht ausführt und keine Fehlerfreiheit garantiert – es ist ein Assistent, keine Ersatz für Debugging.
Tool öffnen: Code-Erklärer ↗Oberflächenübersetzungen sind maschinell unterstützt und können eine Überarbeitung benötigen.