Difference between revisions of "Codestijl"
From A-Eskwiki
(Opmerking over stijl fixen) |
(Regel over witruimte na een blok) |
||
| Line 2: | Line 2: | ||
* Indentatie is een tab, en doorgaan van regels is twee tabs. | * Indentatie is een tab, en doorgaan van regels is twee tabs. | ||
| − | * Regels langer dan 80 karakters zijn lelijk maar niet verboden. | + | * 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, <code>if</code>, <code>foreach</code> etc.) komt precies één witregel. | ||
* Klassen zijn UpperCamelCase en functies, variabelen enzo zijn lowerCamelCase. | * Klassen zijn UpperCamelCase en functies, variabelen enzo zijn lowerCamelCase. | ||
* Heb je een afkorting zoals CSV, dan doen we CamelCase nog steeds met hoofdletters: <code>CSVPagina</code>, niet <code>CsvPagina</code>. | * Heb je een afkorting zoals CSV, dan doen we CamelCase nog steeds met hoofdletters: <code>CSVPagina</code>, niet <code>CsvPagina</code>. | ||
Revision as of 00:09, 5 December 2017
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,foreachetc.) 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, nietCsvPagina. - Doxygen-commando's zijn met @:
@brief,@parambla,@returns, enz. - De
HTMLPagemaak je aan in de controller, de view returntHTMLObjecten die je erin kan stoppen. - Als je wilt je checken of iets
NULLis, gebruik dan altijdis_null().
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).
