Code-Kommentare schreiben, die Entscheidungen erklären.
Kommentare sollten Absicht oder eine nicht offensichtliche Einschränkung erklären. Eine einfache Codezeile in Prosa zu wiederholen erzeugt Rauschen.
Passe den Ablauf an deine Aufgabe an.
Ermittle den nicht offensichtlichen Grund, die Invariante oder Einschränkung und erkläre sie bei der relevanten Operation. Entferne Kommentare, die nur klare Syntax nacherzählen, und richte die Erklärung am tatsächlichen Verhalten aus.
- Was du bereitstellst
- Code und Dokumentationsstil des Projekts.
- Was du erhältst
- Nützliche Kommentare zu Absicht und Einschränkungen.
Sieh dir Eingabe und Ergebnis an.
Beispielhafte Ein- und Ausgabe · ein Lehrbeispiel, kein tatsächlicher WebAct-Durchlauf
Beispiel Eingabe
Add an intent comment to this JavaScript mapping. Original row IDs must remain available so reviewers can trace comparison results to their sources.
const copied = rows.map(row => ({ ...row }));Vollständiges Beispiel
// Retain source row IDs so reviewers can trace each comparison finding.
const copied = rows.map(row => ({ ...row }));
The comment explains why the IDs remain. The code still makes shallow copies; nested objects are shared.Lade diese Eingabe in den Prompt und kopiere ihn zum Ausprobieren nach WebAct. Dein Ergebnis kann vom Beispiel abweichen.
Entscheidungen und Fehlerbehebung.
Sollte jede Zuweisung einen Kommentar erhalten?
Kommentiere dort, wo Absicht oder Einschränkung sonst unklar wäre. Code in Prosa zu wiederholen schafft Wartungsarbeit, ohne eine Entscheidung zu erklären.
Warum wird ein hilfreicher Kommentar nach einem Refactoring irreführend?
Prüfe ihn mit dem geänderten Verhalten und aktualisiere oder entferne veraltete Annahmen. Kommentare gehören zur gepflegten Erklärung.
Probiere es mit deiner eigenen Quelle.
Ersetze das Beispiel im Aufgaben-Prompt durch dein Material. Behalte nötige Anforderungen bei und kopiere die Aufgabe nach WebAct.
Aufgabe anpassen und kopieren ↑