3 tips om clean code te schrijven

Code moet duidelijk zijn. Je moet op elk moment terug door je code kunnen gaan en begrijpen wat er geschreven staat. Je moet ook direct een aanpassing moeten kunnen maken als er een probleem naar boven komt. Hieronder geef ik je enkele tips hoe je je code zo clean mogelijk kunt houden.

  1. Keep it simple stupid (KISS)

    Hou je code simpel. Al je de mogelijkheid hebt om je code op een simpele manier te schrijven, doe dit dan.

    Het concept van simpelheid is een vaag en subjectief principe, waardoor je keuze van context en per persoon kan veranderen.

    Bekijk onderstaand voorbeeld:

    Zowel weekday1 als weekday2 doen hetzelfde. Ze geven allebei de dag van de week terug. Maar welke methode is nu simpeler?

    Methode 2 is korter en het programma doorloopt minder stappen wanneer deze door de functie loopt.

    Methode 1 daarentegen gebruikt minder functies, alleen een switch statement, om zijn doel te bereiken en is veel leesbaarder dan methode 2.

    Nu ligt de keuze bij jouw. Ben jij zelf ervaren met de taal waarin je werkt? En je teamleden ook? Dan is weekday2 misschien een betere methode voor jou, aangezien deze niet als moeilijk zal gezien worden.

    Als je daarentegen minder expertise hebt in deze taal, of je wil graag een meer visueel beeld hebben van je methode, dan is weekday1 de keuze voor jou.

  2. Don’t repeat yourself (DRY)

    Dit staat voor het principe dat een functionaliteit van het domein waar je je programma voor maakt maar op 1 plaats mag gedeclareerd worden. Wil je dit dan op een andere plaats gebruiken? Dan moet je de origineel gedeclareerde functionaliteit aanspreken.

    Makkelijk gezegd betekent dit dat als je een aanpassing moet maken aan je systeem, dan zorg je dat je maar 1 plaats moet bewerken.

    Het voorbeeld dat ik altijd gebruikt is SASS. SASS is een css framework die een functionaliteit heeft die dit principe zeer goed aantoont. Stel je hebt onderstaande css file:

    In deze css file worden op enkele plaatsen de kleur van elementen bepaald. Bij veel van deze elementen is dit dezelfde kleur, omdat je in een bepaalde stijl werkt.

    Stel nu dat je al je zwarte tekst wil veranderen door een donker blauw, dan zou je elke ‘color: black’ moeten veranderen door bijvoorbeeld ‘color: darkblue’. Dit is heel veel nutteloos werk.

    De oplossing dat SASS brengt is variables. Kijk naar deze files twee files:

    Als je, zoals in de css file, de zwarte tekstkleur wil veranderen van naar een donker blauw, dan moet je alleen de variabele van op de eerste file aanpassen en dan veranderen alle zwarte teksten naar donker blauwe.

    Zo moet je maar op 1 plaats bewerken om een aanpassing in je programma uit te voeren.

  3. Boy Scouts Rule

    “Always leave the campingground cleaner than you found it”. Dit is een van de regels van de boy scouts. Als je dit toepast op code dan betekent dit: Laat code altijd properder achter dan dat je ze gevonden hebt. Het maakt niet uit wie het geschreven heeft, als je code vind die beter kan geschreven worden, dan verbeter je die.

    Neem als voorbeeld onderstaande code:

    Als je de eerste array tegenkomt in een template of code dat je gedownload hebt. Verbeter die dan naar de 2de versie. Deze is veel leesbaarder en een meerwaarde voor iedereen.

  4. Conclusie

    Code moet altijd later terug leesbaar zijn. Om ervoor te zorgen dat jouw code duidelijk is kan je enkele technieken toepassen. KISS: schrijf je code op een manier die voor jou en teamleden simpel overkomt. DRY: zorg dat je per functionaliteit 1 origine punt hebt zodat je aanpassingen aan die functionaliteit maar op 1 plaats moet uitvoeren. En de boy scouts rule: laat code leesbaarder en duidelijker achter dan je hem gevonden hebt.