News

Montag, 3. Mai 2010 | News

Die sieben Säulen schönen Codes

(Link zum Artikel: http://www.it-republik.de/php/news/055238)
  • Teilen
  • kommentieren
  • empfehlen
  • Bookmark and Share

Schönheit ist relativ, das wussten schon die alten Römer – auch wenn Marcus Antonius die Nase der ägyptischen Königin Kleopatra bekanntlich recht anziehend fand. Abgesehen davon gibt es jedoch auch eine andere Bedeutung, die man aus dem Wort schön ableiten kann; wie es zum Beispiel Christopher Seiwald in seinem Whitepaper Die sieben Säulen schönen Codes macht.

Das Wesentliche schönen Codes ist, dass man viel von der Codestruktur auf einen Blick ableiten kann, ohne ihn vollständig zu lesen. Ich nenne das „visuelle Syntaxanalyse“: den Fluss und die relative Wichtigkeit des Codes über seine Form wahrnehmenChristopher Seiwald

Es geht also in erster Linie darum, anderen das Lesen des eigenen Codes einfacher zu machen. Sein Beispiel baut er exemplarisch an jam/make.c auf; es sollte jedoch kein Problem sein, diese einfachen Regeln auch auf andere Sprachen anzuwenden.

Und was sind nun seine sieben Säulen schönen Codes? Vieles davon ist den meisten eigentlich bereits ins Blut übergegangen – aber vielleicht findet man ja noch die eine oder andere Säule, über die man sich Gedanken machen könnte:

  1. Stilkonformes arbeiten
  2. Buchformat verwenden
  3. Entwirren von Code-Blöcken
  4. Kommentieren von Code-Blöcken
  5. Aufräumen
  6. Gleiche Funktionen und gleiches Aussehen
  7. Überwinden der Einrückung

Wie der Autor schon feststellt, sind dies sicherlich nicht das erste und auch bestimmt nicht das letzte Wort zu gutem Code. Aber ein wenig Einheit kann schließlich nie schaden.

(tw)

Anzeige

Kommentare

Gravatar toosten 03.05.2010
um 08:33 Uhr
8.) Verwende nie /* */ für Kommentare innerhalb einer Funktion!

Und eine Breite von 80 Zeichen auf 16:x Monitoren, empfinde ich als überholt! Denn ich habe gelernt das man eine Methode/Funktion auf einen Monitor bekommen sollte, somit die das Problem nicht die Breite, sondern meist die Höhe!
#zitieren
Gravatar Trepper 03.05.2010
um 09:30 Uhr
Zum Thema sauberer Code ist das Buch "Clean Code" sehr empfehlenswert!

@toosten
Eine Breite von 80 Zeichen macht auch auf großen Monitoren Sinn, denn erstens kann man Text mit kurzen Zeilen besser lesen und zweitens gibt es durchaus Entwickler, die mehr als eine Datei nebeneinander darstellen.
#zitieren
Gravatar toosten 03.05.2010
um 18:00 Uhr
@Trepper
Für mich ist es wichtiger den Code durch Tabulatoren zu formatieren und die begrenzte Anzahl der Zeilen einzuhalten, als mich auf 80 Zeichen in einer Zeile zu begrenzen!
#zitieren
Gravatar mschnide 03.05.2010
um 21:00 Uhr
80 Zeichen nicht mehr lesbar, dies wurde schon mehrfach festgestellt. Es gibt auch schon Ansätze, die 60 Zeichen empfehlen!
Es ist wie ein Word-Dokument zu lesen. Einfach nicht machbar! Man weiss einfach nicht mehr, in welcher Zeile man sich befindet.
#zitieren
Gravatar Thomas Wacker 03.05.2010
um 22:47 Uhr
Naja, was da so alles steht, vor allen Dingen die Aufteilung der geschweiften Klammern halte ich für fragwürdig. Warum sollte man sich nicht einfach an Standard Coding Guides halten (wie z. B. Zend). Würde vieles vereinfachen... #zitieren
Gravatar nik 20.12.2010
um 14:32 Uhr
Ich finde 80 Zeichen durchaus berechtigt. Zum einen lässt sich Code im schlimmsten Fall sogar auf der Kommandozeile listen (das ist der alte Hintergrund), zum zweiten kann meine IDE so problemlos noch Sidebars wie Structure-Tree oder Snippetsammlung anzeigen.
60 Zeichen fände ich auch noch übersichtlicher, allerdings verwende ich konsequent sprechende Bezeichner, die auch schon mal etwas länger geraten.

Was 80 Zeichen jetzt mit Tabs zu tun haben sollen (die kann man schließlich auch kleiner stellen), erschließt sich mir nicht.
#zitieren
Gravatar micha 20.12.2010
um 17:58 Uhr
Ich kann ebenfalls unbedingt das Buch "Clean Code" zu diesem Thema empfehlen (das kann man nicht oft genug sagen).
Auch stimme ich der 80-Zeichen-Regel zu: je weniger die Augen wandern müssen, desto schneller versteht man was da passiert. Das gilt natürlich auch insbesondere für die Vertikale.
#zitieren

Folgende Links könnten Sie auch interessieren

zurück zum Seitenanfang