Skip to content

Styleguide

TillWenke edited this page May 21, 2022 · 10 revisions

Allgemein

  • Auf Leerzeichen/zeilen am Ende von Methoden achten!
  • Kein defensives Klammern
  • Methodenkategorien, benennung,... überdenken
  • messages mit parametern: parameter klein schreiben
  • self überall einsetzen
  • Nie element, object oder each in iteratoren
  • ! Auch auf Klassenseite überprüfen!

Einrückung & Leerzeichen

  • Nie mehr als ein Statement in einer Zeile
  • Positionen mit x @ y angeben (Leerzeichen beachten)
  • if branches immer in nächste Zeile
  • genau eine Einrückung für ifTrue/ifFalse in der nächsten Zeile
    • für jeden neuen if branch je eine Einrückung
  • Schleife mit nur einem Statement in einer Zeile schreibenzB xy do: [:entity | entity]
    • Beispiel für mehrzeilige Schleife:
    • self bricks, self coins do: [:entity | entity positionRelativelyTo: self game. self spawn: entity].
  • kein Leerzeichen am Anfang von Blöcken, auch nicht bei z.B.: [:element | element]
  • Kaskadierung: wenn mehrere Elemente, dann neue Zeile je Element; wenn nur ein Element, dann alles in eine Zeile

Punkte

  • returns: ^ xyz (mit Leerzeichen, ohne Punkt)
  • alle Methoden ohne return value haben einen Punkt am Ende
  • der letzte Aufruf im Block hat kein Punkt z.B.: [self abandon].

How to?

  • Blöcke, siehe applyPhysics, step

ACHTUNG:

  • -> bitte auf Konsistenz in den Klassenkommentaren achten (besonders Groß-/Kleinschreibung)
Clone this wiki locally