Codestijl

From A-Eskwiki
Revision as of 16:45, 10 December 2017 by Timb (Talk | contribs)

Jump to: navigation, search

Omdat we nog genoeg fietsenstallingen hebben, hebben we hier een korte opsomming van wat we mooie stijl vinden.

  • Indentatie is een tab, en doorgaan van regels is twee tabs.
  • Regels langer dan 80 karakters zijn lelijk maar niet verboden. Dus, wees niet bang om statements en expressies over meerdere regels te verdelen.
  • Na een blok (functiedefinities, if, foreach etc.) komt precies één witregel.
  • Klassen zijn UpperCamelCase en functies, variabelen enzo zijn lowerCamelCase.
  • Heb je een afkorting zoals CSV, dan doen we CamelCase nog steeds met hoofdletters: CSVPagina, niet CsvPagina.
  • Code is Nederlandstalig, dus gebruik Nederlandse woorden. Ga hierin ook weer niet te ver: BlaView::tabel() ipv BlaView::table() maar BlaView ipv BlaBlik.
  • Doxygen-commando's zijn met @: @brief, @param bla, @returns, enz.
  • De HTMLPage maak je aan in de controller, de view returnt HTMLObjecten die je erin kan stoppen.
  • Als je wilt je checken of iets NULL is, gebruik dan altijd is_null().
  • Gebruik Responses ipv stateful functies.
  • Gebruik new $blaPage() ipv Page::getInstance('$bla')

Vul je andere favoriete pet peeves hier in!

Als je iets in code verandert die zich niet helemaal houdt aan deze stijl, fix dat dan (minstens in de methode waar het om gaat).