x

Einloggen

Hast du noch keinen Account? Jetzt registrieren!

Fünf Regeln, um guten Code zu schreiben

1. Schreiben Sie für eine breite Leserschaft

Code ist darauf ausgelegt, Jobs zu überdauern. Wenn wir Code verfassen, halten wir ihn nicht nur für uns selbst fest, sondern für eine Leserschaft von Kollegen und Nachfolgern, die ihn ansehen und pflegen. Wollen wir, dass sie dies mit Ehrfurcht und Respekt tun oder mit einem Kopfschütteln? Leicht zu pflegenden Code zu verfassen, macht unser Leben nicht nur einfacher, sondern auch das der Personen um uns herum und erntet Bewunderung, Lob und Lohn, der zwar nicht immer finanzieller Natur ist, aber zumindest gut für unser Karma ist.

2. Erstellen Sie einen sauberen Rahmen für zukünftige Änderungen

Beginnen wir damit, einen neuen Code aufzusetzen und gehen wir dabei wie folgt vor: wir kopieren eine Zeile und unterteilen diese in zehn Funktionen. Was passiert, wenn nun jemand eine elfte Funktion hinzufügen will? Seien wir ehrlich – selbst die sorgfältigsten Programmierer sind ab und zu bequem. Wenn etwas zehn Mal kopiert wird, wird es wahrscheinlich auch ein weiteres Mal kopiert und ein Jahr später, wenn wir herausfinden, dass die komplette Logik oder der Inhalt einer Zeile geändert werden muss, müssen wir anstatt einer einzigen Zeile 50 Zeilen überarbeiten.

Code zu entwirren ist immer komplizierter, als Code zu schreiben und wir hätten die Verbreitung des copy-and-paste Virus vermeiden können, indem wir unseren Code gleich zu Beginn darauf ausgelegt hätten, in wiederholter Weise zum Einsatz zu kommen. Erstellen sie stets einen sauberen Rahmen, an dem sich andere orientieren können, indem Sie deutlichen Code schreiben, der Wiederholungen reduziert und Wartungsarbeiten unterstützt, indem einzelne Logik- und Inhaltsfragmente isoliert werden.

3. Schreiben Sie kurz, selbsterklärend und vermeiden Sie Inline-Kommentare

Funktionen, die sich über fünf Zeilen erstrecken und beschreibende Namen haben, sind leicht verständlich. Hier werden keine Kommentare benötigt. Dreißig Zeilen hingegen erfordern reichlich Gehirnkraft und beinhalten muffige Kommentare, die über die Zeilen verstreut wurden, um die Funktionen zu erläutern. Hundert Zeilen grenzen an Körperverletzung. Wenn wir auf Code treffen, der mit Kommentaren übersät ist, gibt es Verständnisprobleme. Unterteilen Sie langen Code in mehrere kleine Funktionen mit selbsterklärenden Namen und Sie werden sehen, dass er sich wie ein klar verständliches und präzises Rezept liest, das Kommentare überflüssig macht. Betrachten Sie Kommentare innerhalb von Funktionen so, als seien sie Parasiten – mit Argwohn.

4. Folgen Sie Gewohnheiten und allgemein anerkannten Standards

Wenn wir Gewohnheitsregeln brechen, wird sich die nächste Person, die unseren Code liest fragen, warum wir dies gemacht haben. Wenn unser Code Fragen zu seiner Stilistik aufkommen lässt, wundert sich der Leser möglicherweise, ob ein spezieller Grund vorlag, weshalb wir unseren Code in dieser Form geschrieben haben. Noch schlimmer wäre es, wenn Sie unseren ungewöhnlichen Stil aufgreifen und aufrechterhalten, indem sie ihn kopieren. Dies sorgt letztendlich dafür, dass Code unnötig erschwert wird und die Zeit anderer Personen verschwendet. Ich habe mehr als nur einmal Argumente von Personen zu hören bekommen, die lieber in ihrem eigenen Stil Code schreiben als den gängigen Gepflogenheiten zu folgen. Dies trifft meist dann zu, wenn Personen eine neue Programmiersprache verwenden, ohne sich die Zeit zu nehmen, sich die neuen Gewohnheiten und Techniken anzueignen. Denken Sie daran, dass von uns verfasster Code wahrscheinlich von einer anderen Person gepflegt wird. Erleichtern Sie ihren Job und ersparen Sie Ihren Kollegen eine lange Einlesephase, indem Sie sich an die allgemein anerkannten Standards halten. Dies mag zu Beginn zwar etwas mehr Aufwand bedeuten, wird sich aber bezahlt machen, wenn es um die Wartung geht.

5. Machen Sie sich mit der Sprache und der Struktur vertraut

Es wird viel schlechter Code verfasst, weil die Sprache oder die Grundstruktur ignoriert werden. Wenn wir die Struktur, in der wir arbeiten nicht kennen, erfinden wir möglicherweise das Rad neu oder schreiben stumpfen Code, weil wir die Gewohnheitsregeln und Hilfsmittel, die bereits erschaffen wurden, nicht nutzen. Sie müssen nicht zu einem wandelnden Lexikon werden, aber sie sollten zumindest ab und an einen Blick auf seine Seiten werfen, um herauszufinden, was vor sich geht. Ich bin immer wieder erstaunt, was ich in Strukturen vorfinde, die ich bereits seit längerer Zeit anwende, und wie sich meine Arbeit dadurch vereinfacht. Vernachlässigen Sie fachspezifische Informationen nicht und verfolgen Sie Blogs, die sich mit dieser Thematik beschäftigen.
1726 Mal gelesen
+3
29. Dez 2009, 13:48

Kommentare

(0)
RSS

Kommentieren

Fett Kursiv Unterstrichen Durchgestrichen   Link Zitieren Code
Ich bin mit den Nutzungsbedingungen einverstanden.
Zukünftige Kommentare zu diesem Beitrag abonnieren (abbestellbar).
 
Bitte klicke jetzt auf den Bestätigungslink in deiner E-Mail.