Coding standards - Txai-HvA/BlokTech GitHub Wiki

Ik heb naar Clean Code Javascript gekeken en een aantal van deze principes overgenomen. Verder heb ik gebruik gemaakt van een linter, die fouten opspoort zoals error, bugs, dode code en een formatter om de code netjes te maken.

Use searchable names

Het is belangrijk dat code leesbaar en doorzoekbaar is. Door geen variabelen te noemen die zinvol blijken te zijn om je app te begrijpen, is het lastig voor andere programmeurs je code te snappen.

Aangezien ik deze user id vaker gebruik en voor sommige onduidelijk is wat het is, heb ik hier een aparte variabel voor gemaakt.

Voor

Na

Remove dead code

Dode code is net zo slecht als dubbele code. Er is geen reden om het in je codebase te houden. Als je het later weer wilt gebruiken, kan je ook terug gaan in je versie geschiedenis of het ergens anders opschrijven. Aangezien ik const result niet opnieuw gebruikte, had ik deze verwijderd.

Na

Only comment things that have business logic complexity

Comments zijn geen vereiste. Goede code documenteert zichzelf meestal. Ik heb comments verwijderd, waarbij de code zichzelf uitlegde en er geen comments nodig waren.

Voor

Na

Avoid positional markers

Ik wilde bepaalde stukken code van elkaar scheiden, maar dit zorgde eigenlijk alleen maar voor dat het er rommelig uit zag.

Voor

Na

Don't leave commented out code in your codebase

Code die gecomment is die je niet meer gaat gebruiken, kan je net zo goed weg halen. Het blijft altijd bewaard in je versie geschiedenis. Aangezien ik nu een database gebruik, is het niet meer nodig deze gecommente code te behouden.

Voor

Na

Overig

Tenslotte heb ik met eslint ingesteld dat:

• Semicoloms verwijderd worden
• Er wordt altijd met 4 spaties ingesprongen
• Alleen enkel quotes mogen worden gebruikt
• Variabelen die niet worden gebruikt geven een error