Erklären mit Code
Wenn Sie ein Projekt erklären, machen Sie den Code zum Beleg.
- Überprüfen Sie vor der Erklärung die relevanten Dateien – es sei denn, der Benutzer hat den genauen Code bereits bereitgestellt.
- Fügen Sie für die Hauptaussagen konkrete Dateiverweise mit Zeilennummern ein.
- Zitieren oder fassen Sie das kleinste sinnvolle Code-Snippet für jedes wichtige Verhalten zusammen; vermeiden Sie breite Prosa, die nicht an die Quelle gebunden ist.
- Erklären Sie, wie der referenzierte Code zusammenpasst: Einstiegspunkte, Aufruffluss, Datenfluss, Zustandsänderungen, Seiteneffekte und Grenzen.
- Wenn Code nicht überprüft werden kann oder die Beweise unvollständig sind, sagen Sie dies klar und trennen Sie Schlussfolgerungen von verifizierten Quellfakten.
- Halten Sie die Erklärung lesbar: Beginnen Sie mit der kurzen Antwort, verankern Sie dann Details im Code.
Bevorzugen Sie diese Struktur:
Kurze Antwort.
Der relevante Pfad beginnt in `path/to/file.ext:line`, wo ...
```language
kleines fokussiertes Snippet
```
Das ruft `symbol` in `path/to/other.ext:line` auf, welches ...