Dokumentation und Clean Code

Aktive Methoden wie Code-Analysen und Reflexionsrunden zeigen Schülern sofort, warum Dokumentation und Clean Code mehr sind als Regeln. Durch das eigene Erleben verstehen sie, dass gut strukturierter, lesbarer Code Zeit spart und Fehler reduziert, während reine Kommentare oft nur Symptome verdeckter Probleme sind.

• Klasse 10
• Digitale Welten Gestalten: Informatik in der Praxis
• 3 Aktivitäten
• 20 Min.–40 Min.

Lernziele

1. Analysieren Sie die Auswirkungen von schlechter Code-Formatierung und unklaren Variablennamen auf die Lesbarkeit und Wartbarkeit von Software.
2. Bewerten Sie die Qualität von technischer Dokumentation anhand definierter Kriterien wie Vollständigkeit, Genauigkeit und Verständlichkeit.
3. Erstellen Sie eine kurze technische Dokumentation für eine einfache Funktion oder Klasse unter Anwendung von Konventionen wie Javadoc.
4. Entwerfen Sie Refactoring-Strategien zur Verbesserung von Code-Abschnitten, die als 'Spaghetti-Code' identifiziert wurden.
5. Erklären Sie die Prinzipien von Clean Code und deren Bedeutung für die Teamarbeit und die langfristige Projektgesundheit.

Forschungskreis

⏱ 40 Min.·Kleingruppen

Forschungskreis: Code-Detektive

Schüler erhalten zwei Versionen desselben Programms: Eine mit kryptischen Namen und eine in 'Clean Code'. Sie müssen unter Zeitdruck eine Änderung vornehmen und vergleichen, wo es schneller ging.

Vorbereitung & Details

Warum schreiben wir Code primär für Menschen, nicht für Maschinen?

Moderationstipp: Stellen Sie sicher, dass die anonymisierten Code-Schnipsel für die Peer-Bewertung realistische Fehler enthalten, die die Schüler selbst gemacht haben könnten.

Setup: Gruppentische mit Zugang zu Quellenmaterialien

Materials: Quellensammlung, Arbeitsblatt zum Forschungszyklus, Leitfaden zur Fragestellung, Vorlage für die Ergebnispräsentation

• Analysieren
• Bewerten
• Erschaffen
• Selbststeuerung
• Selbstwahrnehmung

Museumsgang

⏱ 35 Min.·Ganze Klasse

Museumsgang: Die Dokumentations-Wand

Gruppen erstellen Plakate mit Best Practices für Clean Code (z.B. 'Don't repeat yourself'). Sie hängen Beispiele für 'schlechten' und 'guten' Code daneben auf.

Vorbereitung & Details

Was macht eine gute technische Dokumentation aus?

Moderationstipp: Legen Sie bei der Dokumentations-Wand Wert darauf, dass die Schüler nicht nur Texte sammeln, sondern auch die Struktur und Verständlichkeit der Beispiele diskutieren.

Setup: Wandflächen oder Tische entlang der Raumwände

Materials: Plakatpapier oder Posterwände, Marker, Haftnotizen für Feedback

• Verstehen
• Anwenden
• Analysieren
• Erschaffen
• Beziehungsfähigkeit
• Sozialbewusstsein

Ich-Du-Wir (Denken-Austauschen-Vorstellen)

⏱ 20 Min.·Partnerarbeit

Ich-Du-Wir (Denken-Austauschen-Vorstellen): Kommentare vs. Lesbarer Code

Schüler diskutieren: 'Sollte man jede Zeile kommentieren oder den Code so schreiben, dass er sich selbst erklärt?'. Partner erarbeiten Regeln für sinnvolle Kommentare.

Vorbereitung & Details

Wie verhindern wir „Spaghetti-Code"?

Moderationstipp: Fordern Sie die Schüler beim Think-Pair-Share auf, konkrete Beispiele aus ihrem eigenen Code zu nennen, um die Diskussion zu veranschaulichen.

Setup: Standard-Klassenzimmer; die Lernenden wenden sich dem Sitznachbarn zu

Materials: Diskussionsimpuls (projiziert oder gedruckt), Optional: Notizblatt für die Partnerarbeit

• Verstehen
• Anwenden
• Analysieren
• Selbstwahrnehmung
• Beziehungsfähigkeit

Dieses Thema unterrichten

Lehrer sollten hier als Vorbilder agieren: Zeigen Sie Ihren eigenen Code und erklären Sie, warum Sie bestimmte Entscheidungen getroffen haben. Vermeiden Sie es, Dokumentation als lästige Pflicht zu vermitteln. Stattdessen betonen Sie, dass sie ein Werkzeug ist, das die Zusammenarbeit erleichtert. Nutzen Sie echte Beispiele aus der Praxis, um zu zeigen, wie schlecht dokumentierter Code zu kostspieligen Fehlern führt.

Was Sie erwartet

Am Ende dieser Einheit sollen Schüler nicht nur die Regeln von Clean Code kennen, sondern sie bewusst anwenden. Sie analysieren Code anderer, erkennen Mängel und überarbeiten eigene Projekte. Ihr Feedback zeigt, dass sie zwischen oberflächlicher Dokumentation und echter Codequalität unterscheiden können.

Vorsicht vor diesen Fehlvorstellungen

Häufige Fehlvorstellung

Während der Aktivität 'Code-Detektive' beobachten Sie, dass Schüler glauben, ausführliche Kommentare könnten schlechten Code ausgleichen.

Was Sie stattdessen lehren sollten

Nutzen Sie die anonymisierten Code-Schnipsel, um gezielt zu zeigen, wie Kommentare oft nur Verwirrung stiften, wenn der Code selbst unklar ist. Fordern Sie die Schüler auf, den Code umzustrukturieren statt ihn zu kommentieren.

Häufige Fehlvorstellung

Während der Aktivität 'Die Dokumentations-Wand' fällt auf, dass Schüler die Dokumentation erst am Ende erstellen wollen.

Was Sie stattdessen lehren sollten

Verweisen Sie auf die gesammelten Beispiele an der Wand und fragen Sie: 'Würde dieser Code auch ohne Dokumentation verstanden?' Lassen Sie die Schüler ihre eigenen alten Projekte überprüfen und notieren, welche Teile ohne Dokumentation unverständlich wären.

Ideen zur Lernstandserhebung

Gegenseitige Bewertung

Während der Aktivität 'Code-Detektive' erhalten die Schüler anonymisierte Code-Schnipsel ihrer Mitschüler. Sie bewerten auf einer Checkliste die Qualität des Codes und geben eine schriftliche Begründung für eine konkrete Verbesserung.

Lernstandskontrolle

Nach der Aktivität 'Gallery Walk' notieren die Schüler zwei konkrete Vorteile von Clean Code für die Softwareentwicklung und nennen ein Beispiel für eine gute technische Dokumentation, die sie kennen oder sich vorstellen können.

Diskussionsfrage

Während der Aktivität 'Think-Pair-Share' diskutieren die Schüler in Kleingruppen: Warum ist es für einen Anfänger schwieriger, guten Code zu schreiben als nur funktionierenden Code? Welche Rolle spielt die Dokumentation, wenn ein Projekt nach einem Jahr wieder aufgenommen wird?

Erweiterungen & Unterstützung

• Fordern Sie schnelle Schüler auf, einen kurzen, aber vollständigen Dokumentationskommentar für eine komplexe Funktion zu schreiben, der auch die Design-Entscheidungen erklärt.
• Für Schüler, die unsicher sind, geben Sie eine Checkliste mit konkreten Kriterien für lesbaren Code (z.B. Variablennamen, Funktionlänge, Kommentare nur bei Unklarheiten).
• Vertiefen Sie das Thema, indem Sie die Schüler ein Mini-Projekt dokumentieren lassen, das sie vor einem Jahr geschrieben haben, und die Unterschiede analysieren.

Schlüsselvokabular

Clean Code	Ein Programmierstil, der darauf abzielt, Code nicht nur funktional, sondern auch lesbar, verständlich und wartbar zu machen.
Spaghetti-Code	Umgangssprachlicher Begriff für schlecht strukturierte, schwer nachvollziehbare Programmabläufe mit vielen Sprüngen und Abhängigkeiten.
Javadoc	Ein Dokumentationsgenerator für Java, der aus speziellen Kommentaren im Quellcode automatisch API-Dokumentationen erstellt.
Refactoring	Der Prozess der Umstrukturierung von bestehendem Computercode, ohne das externe Verhalten zu ändern, um die Lesbarkeit und Wartbarkeit zu verbessern.
Sprechende Variablennamen	Variablenbenennung, die ihren Zweck oder Inhalt klar und eindeutig beschreibt, anstatt kryptische Abkürzungen zu verwenden.