Ansicht umschalten
Avatar von AmigoJack
  • AmigoJack

mehr als 1000 Beiträge seit 24.05.2006

Ich widerspreche allen 5 Regeln

Code sollte einer einheitlichen Formatierung folgen, die entweder ĂĽber einen Linter oder eine automatische Formatierung erzwungen wird.

Kenne ich: Code-Fetzen in vorgegossene Betonblöcke schreiben, weil ich in eine Schublade mit der Doofheit aller anderen gesteckt werde. Ist aber für mich deutlich mühseliger zu bewerkstelligen, erst recht wenn ich noch nicht einmal hin- und her-tabben kann sondern jedesmal mit Maus klicken muss.

Einheitliche Formatierung: ja, gerne. Aber auch Leute abholen, die schon diszipliniert genug dafĂĽr sind, statt die zu vergraulen.

Variablen- und Funktionsnamen sollten fachlich und nicht technisch gewählt werden

Ich bin leichter Verfechter der ungarischen Notation, nur nicht so ausgeprägt: Variablennamen wie "iLevel", "rMedian" und "sType" zeigen doch praktischerweise direkt, welcher Datentyp dahintersteckt. Könnte man je nach IDE auch farblich trennen, aber nicht immer ist der Lieblingseditor verfügbar.

Code innerhalb einer Funktion sollte sich ungefähr auf demselben Detailgrad bewegen.

Funktionen trennen, so wie Texte durch Absätze? Das kann ich pauschal so nicht gutheißen, weil dann auch wieder viel Fragmentierung einhergehen kann. Da kann ich genausogut stumpf fordern: eine Funktion darf nie mehr als 20 Zeilen haben.

Kürze alleine führt nicht zu besserer Lesbarkeit – häufig ist genau das Gegenteil der Fall.

Irgendwo ist aber auch die Linie zu ziehen: ich brauche kein IF, nur um unter THEN dann einen Boolean auf TRUE zu setzen und im ELSE auf FALSE. Oder eine Variable zu setzen, nur um sie einmal gleich in der nächsten Zeile zu verwenden/übergeben. Unnötig zu ausführlich. Am Ende sieht sich keiner mehr im Stande reguläre Ausdrücke lesen zu können...

Kommentare sollten nicht das Was dokumentieren, sondern das Warum

Auch das ist zu wenig: in vielen Fällen ist eine Quellenangabe nötig, um auch später nachvollziehen zu können, warum das so gemacht wurde, wie z.B. ein Standard in welcher Version. Das "warum" alleine hab ich schon gesehen bei anderen, aber verstanden hatten die das trotzdem nicht.

Bewerten
- +
Ansicht umschalten