Coding standards

Coding Agreements

Coding standarts geeft een uniform uiterlijk aan de codes die door verschillende developers zijn geschreven. Het verbetert de leesbaarheid en onderhoudbaarheid van de code en het vermindert ook de complexiteit. Het helpt bij het hergebruik van code en helpt om fouten gemakkelijk te detecteren.

Onze coding agreements

• Schrijf zo min mogelijk code.
• Gebruik de juiste namen voor alles.
• Zet je code in blokken/alinea's.
• Gebruik inspringing om het begin en einde van besturingsstructuren te markeren.
• Gebruik het DRY (Don't Repeat Yourself) principe. Automatiseer repetitieve taken wanneer nodig. Hetzelfde stuk code mag niet worden herhaald in het script.
• Gebruik een hoofdletter voor speciale SQL-woorden en functienamen om ze te onderscheiden van tabel- en kolomnamen.
• Vermijd lange rijen. Het is voor mensen gemakkelijker om regelblokken te lezen die horizontaal kort en verticaal lang zijn.
• Alle comments en id's classes (benoemingen) in het Engels.
• Gebruik van camelCase.
• Structuur javaScript zijn eerst variabelen, daarna logica, daarna functies.
• Alleen gebruik van const en lets
• Javascript, css en html in modules opdelen.
• Geen console logjes pushen naar main

Voordelen van code overeenkomsten:

• Biedt uniformiteit aan de code die door verschillende ingenieurs is gemaakt.
• Maakt het maken van herbruikbare code mogelijk.
• Maakt het gemakkelijker om fouten op te sporen.
• Maak code eenvoudiger, leesbaarder en gemakkelijker te onderhouden.
• Verhoogt de efficiëntie van de programmeur en genereert snellere resultaten.

Bron: Coding Standards and Best Practices To Follow. (2021, 2 februari). BrowserStack. Geraadpleegd op 15 maart 2022, van https://www.browserstack.com/guide/coding-standards-best-practices#:%7E:text=Practices%20To%20Follow-,What%20are%20Coding%20Standards%3F,sophisticated%20and%20highly%20functional%20code