Skip to content

Code standards

Sep Duijkersloot edited this page Jun 13, 2024 · 6 revisions

Beschrijf de binnen het team afgesproken code standards.

css

kleuren

  • --primary: #EB8802;
    
  • --secondary: #FFC570;
    
  • --accent: #FFD774;
    
  • --dark: #292929;
    
  • --light: #FAFAFC;
    
  • --grey: #8b8b8b;
    
  • --gray: #c4c4c4;
    

typografie

  • --d1: 3em;
    
  • --h1: 2.5em;
    
  • --h2: 2em;
    
  • --h3: 1.5em;
    
  • --h4: 1.25em;
    
  • --p1: 1.1em;
    
  • altijd em gebruiken.
  • altijd aan deze typografie houden

Javascript

Naamgeving

  • Functies moeten duidelijke namen krijgen die aangeven wat ze doen, indien nodig moeten er comments worden bijgevoegd voor verdere verduidelijking
  • Variabelen moeten d.m.v. hun naam kunnen aangeven wat hun doel is en waar het gebruikt voor kan worden

Commenting

  • Grotere secties code moeten een comment block krijgen die de onderdelen visueel onderscheiden en die verduidelijking geven over de betreffende sectie
  • Voor onduidelijke regels code, schrijf een korte verduidelijkende comment achter of boven de regel code.
Clone this wiki locally