Code-Diff
Dieser Beitrag ist eine Begriffserklärung zum Thema Code-Diff – inklusive kurzer Prüfungsfragen, typischer Praxisbeispiele und passender Tags für die schnelle Wiederholung.
Was ist ein Code-Diff?
Ein Code-Diff zeigt die Unterschiede zwischen zwei Versionen einer Datei oder eines Code-Standes. In der Praxis wird ein Diff vor allem genutzt für:
- Versionskontrolle (z.B. Git)
- Code Reviews (Feedback auf Änderungen)
- Fehlersuche (Was hat sich seit dem letzten funktionierenden Stand geändert?)
- Nachvollziehbarkeit und Dokumentation (Traceability)
Wofür wird ein Diff in Git und in Teams genutzt?
In Teams ist ein Diff die gemeinsame Grundlage, um Änderungen zu verstehen:
- Pull Requests zeigen Diffs, damit Reviewer gezielt kommentieren können.
- CI/CD kann auf Basis geänderter Dateien Tests auswählen oder Regeln prüfen.
- Security/Compliance: Diffs helfen zu verhindern, dass sensible Daten (Tokens, Passwörter) versehentlich committed werden.
Wie liest man ein Diff? (+ / -)
Typisch ist das sogenannte Unified Diff-Format:
-markiert entfernte Zeilen (alt)+markiert hinzugefügte Zeilen (neu)
Einfaches Beispiel
- print("Hallo Welt")
+ print("Hallo Welt!")
+ print("Programmstart erfolgreich.")Erklärung: Die erste Zeile wurde geändert (Ausrufezeichen). Zusätzlich wurden zwei neue Zeilen ergänzt.
Vorteile und Nachteile
Vorteile
- Änderungen sind schnell sichtbar
- Sehr gut für Reviews und Qualitätssicherung
- Hilft bei Bugfixes, weil der Änderungsumfang klar wird
Nachteile
- Große Änderungen sind schwer lesbar
- Ohne Kontext versteht man manchmal nicht, warum etwas geändert wurde
- Für binäre Dateien (Bilder, PDFs) oft nicht sinnvoll
Typische Prüfungsfragen (mit Kurzantwort)
- Was ist ein Code-Diff? Eine Gegenüberstellung von Codeänderungen zwischen zwei Versionen.
- Wie erzeugt man einen Diff in Git?
Mit
git diff, z.B.git diff HEAD~1. - Was bedeuten
+und-?+ist neu hinzugefügt,-wurde entfernt. - Warum ist ein Diff im Code Review wichtig? Weil Reviewer präzise sehen, was geändert wurde und Feedback geben können.
Fazit
Ein Code-Diff ist mehr als ein Vergleich: Er ist ein zentrales Werkzeug für Teamkommunikation, Qualitätssicherung und Nachvollziehbarkeit in Softwareprojekten.