Coding standards - M4TThys123/Blok-Tech-Team GitHub Wiki

Coding standards zijn belangrijk om samen een mooi overzichtelijk project neer te zetten met overzichtelijke en gelijke code. Hierbij onze coding standards voor ons project.

Project

• Als templating engine gebruiken we Handlebars.
• Onnodige bestanden en code zijn weg uit de repo.
• We springen in met 1 tab.
• We schrijven commentaar en variabelen in het Nederlands.
• We schrijven de mappen en files wel in het Engels.

Javascript(JS)

• Functies hebben hun eigen opening bracket op dezelfde lijn als de naam met 1 spatie ertussen.

function mijnFunctie {

• Namen van variabelen schrijven we met het eerste woord volledig in kleine letters, het tweede woord begint met een hoofdletter (bijvoorbeeld: kleineLetters).

CSS

• We vermijden !important zo veel mogelijk.
• We vermijden oude layout properties zoals float zoveel mogelijk.
• We schrijven onze CSS mobile-first.
• CSS selectors hebben een spatie 1 spatie tussen de openingtag.

HTML

• We gebruiken alleen een id voor een element als deze 1 keer voorkomt op de pagina en het nodig is voor de styling van het element of Javascript.
• We schrijven altijd semantisch correcte code en deze wordt gevalideerd door de W3C Validator: zie hier.
• Div's en br's worden alleen gebruikt als dit echt nodig is.