Das lernst du heute
- Kurze Namen, kurze Kommentare
- Spielfassung
- Lesbarkeit erhalten
Das Gewächshaus-Script aus Woche 37 ist gewachsen: Kopfkommentar mit allen Gerätenamen, Einstellwerten, Ausfällen und einer Versionsgeschichte. Alles nützlich – und zusammen über 4096 Zeichen. Der Chip nimmt es nicht mehr.
Kurze Namen, kurze Kommentare
Die meisten Zeichen stecken nicht im Code, sondern in Namen und Kommentaren. Drei Hebel, nach Wirkung sortiert:
| Hebel | spart | kostet |
|---|---|---|
| lange Kopfkommentare auslagern | sehr viel | nichts, wenn die Doku woanders liegt |
| Kommentare hinter offensichtlichen Befehlen streichen | viel | fast nichts |
Namen kürzen (temperatur → temp) | mittel | Lesbarkeit, wenn man übertreibt |
Ein Kommentar wie # Heizung einschalten hinter sbn HEIZ … On 1 sagt nichts, was der Code nicht schon sagt. Ein Kommentar wie # 20 C, darunter Heizung an hinter einem define dagegen schon – der bleibt.
Die Spielfassung
Der IC10-Coder auf dieser Seite hat einen Knopf Spielfassung: Er entfernt alle Kommentare und Leerzeilen, passt Sprünge auf Zeilennummern an und öffnet das Ergebnis als neue Datei. Deine ausführliche Fassung bleibt unverändert.
So bekommst du beides: Die Datei mit allen Erklärungen bleibt bei dir oder in der Bibliothek, in den Chip kommt die kurze Fassung.
In der Spielfassung fehlen auch die Kommentare, die dir im Spiel beim Ändern helfen würden. Wer dort später etwas einstellen will, muss die Einstellwerte erkennen – deshalb sind sprechende define-Namen wie HEIZ_AN wichtiger als jeder Kommentar.
Lesbarkeit erhalten
Kürzen hat eine Grenze. Aus HEIZ_AN wird nicht H1, aus reif nicht r. Die Regel: Ein Name muss im Code ohne Kommentar verständlich bleiben. Gekürzt wird zuerst, was doppelt ist – Erklärungen, die schon im Namen stecken.
Schreib die lange Dokumentation dorthin, wo Platz ist: in die Beschreibung des Scripts in der Bibliothek, in eine Datei neben dem Code oder als einzeilige Zusammenfassung oben im Chip.
Ein guter Kurzkopf passt in eine Zeile: Name, Version und wo der Rest steht. Alles andere kann draußen bleiben.
Schaubild
Übung
Aufgabe
Der Startcode ist das Gewächshaus aus Woche 37 mit einem langen Kopfkommentar – zusammen über 4096 Zeichen. Kürze die Kommentare, bis der Chip unter die Grenze kommt. Der Code selbst bleibt unverändert und muss alle Tests weiter bestehen.
Hinweise
Hinweis 1
Der Code nach dem Kopfkommentar ist schon fertig – das Problem sind nur die Kommentarzeilen oben.
Hinweis 2
Ersetze den Kopfkommentar durch eine Zeile mit Name, Version und Verweis auf die Doku.
Hinweis 3
Der IC10-Coder zeigt dir die Zeichenzahl beim Schreiben an.
Quiz
3 Fragen. Ab 60 % ist das Quiz bestanden – die Auswertung macht der Server.
Tag abschließen
- Übung im Simulator bestanden
- Quiz mit mindestens 60 % bestanden
Ohne Konto wird der Fortschritt nur in diesem Browser gespeichert.
Fehler in dieser Lektion melden
Zum Melden bitte anmelden. Anmelden