5 tips waarmee je beter code kan schrijven

Het schrijven van code is vaak het lastigste bij het ontwikkelen van software. Als je geen goede structuur aanhoudt, dan kan je dit in de toekomst namelijk veel tijd gaan kosten en je veel hoofdpijn bezorgen. Goede code is onderhoudbaar, herbruikbaar en testbaar. Deze tips helpen je development proces zo goed mogelijk in te richten. 

1. Gebruik een code standaard

Het is makkelijk om slechte, ongeorganiseerde code te schrijven. Maar deze code is moeilijk te onderhouden. Het zoeken van bugs in de code kost veel meer tijd dan als de code goed gestructureerd is. Goede code maakt gebruik van een standaard voor het bepalen van namen, opmaak, etc. Het gebruik van een standaard helpt je hierbij, want alle code die wordt geschreven zal op dezelfde manier zijn gestructureerd, wat de leesbaarheid bevorderd.

Je kan je eigen standaard ontwikkelen, maar er zijn ook al talloze standaarden bedacht door anderen. Microsoft heeft de C# Coding Conventions of als je uitgaat van een framework kun je kijken naar het Zend framework.

2. Refactor

Het refactoren van code is een belangrijk onderdeel van een ontwikkelaar zijn (óf natuurlijk haar) werk. Je zou dit zelfs dagelijks moeten doen. Als je code schrijft, zal dit gebeuren met een bepaalde flow. Maar deze flow is niet altijd de beste manier om je code te structureren. Je schrijft wellicht een te grote functie, welke je zou moeten opdelen in een aantal kleine functies.

Bij het refactoren moet je rekening houden met álles. Dus niet alleen een bepaalde functie, maar ook de variabele namen, de argumenten en de output. Omdat het refactoren en het schrijven van code geen wetenschap is, kun je een aantal vuistregels aanhouden:

• Als je functie meer dan 20-25 regels lang is, zit er waarschijnlijk meer logica in en kun je deze het beste opsplitsen in meerdere functies.
• Als je functie of variabele meer dan 20 tekens lang is, dan kun beter nadenken over een andere naam of de hele functie misschien herschrijven volgens het eerste principe.
• Als je veel loops in elkaar hebt, dan ben je waarschijnlijk een zeer intensief proces aan het uitvoeren. In de regel zouden er niet meer dan 2 loops in elkaar moeten zitten.

3. Vermijd globale variabele

Globale variabele zijn, vooral in grote systemen, een groot probleem. Als je applicatie uit miljoenen regels code bestaat en je hebt een waarde die in de gehele applicatie wordt gebruikt, dan kan dit voor grote problemen zorgen. Zo kun je deze naam niet meer lokaal gebruiken in functies, wat de leesbaarheid er niet beter op maakt. Ook kan het een ongewenst effect hebben in de code zelf, omdat je wellicht iets nieuws wilt doen met deze waarde, maar dat wordt onmogelijk gemaakt.

4. Gebruik beschrijvende namen

Gebruik nooit namen zoals k, a, v of test voor je variabelen. Hoe denk je dat code leest als je er een dag niet naar hebt gekeken, of een week, of een maand? Goede code gebruikt beschrijvende namen voor variabelen functies en classes. Houdt hier natuurlijk ook rekening met de afgesproken code standaard. 

5. Gebruik een goede structuur

Structuur in je applicatie is belangrijk. Gebruik dan ook geen complexe structuren, maar houdt het simpel. Als je een map of bestand een naam moet geven, houdt je dan aan de standaard. Splits bovendien al de onderdelen van je code in de juiste mappen. Dus HTML bij HTML, CSS bij CSS en Javascript bij Javascript. Als je dit door elkaar gaat plaatsen, kun je het moeilijker terug vinden. Maar als je een Javascript-functie zoekt en die staat in de juiste map, dan heb je het sneller gevonden.

Conclusie

Hierboven zijn een aantal tips genoemd die het leven van een softwareontwikkelaar makkelijker kunnen maken. Het zijn geen harde richtlijnen, maar het volgen van deze tips maakt het dagelijks uitvoeren van je werk wel aangenamer. Zo kun je efficiënter omgaan met je tijd en dus meer tijd besteden aan het toevoegen van nieuwe functionaliteiten.

Bent u klaar voor de volgende stap naar Online succes?   

Onze Sigma Solutions experts staan klaar om al uw vragen te beantwoorden over het schrijven van een code voor het verder ontwikkelen van software voor uw B2B bedrijf en helpen u met het zetten van de volgende stap naar Online succes. Neem voor een vrijblijvend adviesgesprek contact met ons op.