Tips om je code leesbaarder te maken

Het moeilijkste aan developen is waarschijnlijk in andermans code duiken en werken. Het is altijd eng om de code van een andere developer te ontleden, maar houd je deze tips in je achterhoofd bij het coderen, lukt het je collega’s vast en zeker!

Respecteer elkaars inspringing

Eén van de dingen die mijn OCD-geest echt triggert, is wanneer verschillende types inspringingen worden gebruikt in een project. In realiteit heeft ieder zijn mening over of je nu beter tabs of spaties gebruikt.

Het kan dus moeilijk zijn om hier tot een akkoord te komen. Probeer een .editorconfig bestand te hanteren bij het programmeren. Hier kan je de inspringingsregels oplijsten voor elk bestandstype. De meeste IDE’s ondersteunen dit of hebben hier plugins voor (inclusief Sublime Text, Visual Studio Code, …).

Creëer het .editorconfig bestand als je begint met het project. Zo kan iedereen die je project vervoegt, netjes het .editorconfig bestand volgen.

tips coderen 20

Maak de namen van je variabelen niet te breed

Het is soms moeilijk om goede variabel namen te verzinnen. Misschien zelfs het moeilijkste aan de job van developer! Maar loop er niet van weg. Goede namen voor je variabelen maken een enorm verschil.

Het is misschien soms de gemakkelijke weg om veel te brede namen te kiezen. Maar probeer toch namen als “item”, “results”, “value” te vermijden en vernoem naar wat er in de variabele zit.

 

Gebruik geen afkortingen als je ze niet nodig hebt

Een andere valkuil bij het benoemen van je variabelen is het gebruik van (soms vreemde) afkortingen. Op het moment dat je de code schrijft, weet je perfect waar de afkorting voor staat. Je collega’s kunnen hier echter hun hoofd om breken bij het ontleden.

Elke seconde die je spendeert aan het ontcijferen van code, is een seconde die je niet kunt spenderen aan de belangrijke onderdelen van je code. Schrijf dus steeds zo duidelijk mogelijk, voor iedereen.

tips coderen 2

Stay DRY

Don’t Repeat Yourself! Je hebt dit waarschijnlijk al 100 keren gehoord. Maar het is eens zo belangrijk! Schrijf niet 5 keer dezelfde code in je project. Zo maak je de code moeilijk leesbaar én moeilijk te onderhouden.

Heb je een déjà vu bij het coderen? Neem dan een stap terug en kijk of je geen zaken kunt herformuleren.

tips coderen 1

Laat niets achter in de comments

We hebben het allemaal al wel eens meegemaakt. Je bent code aan het lezen en er staat ineens een (belangrijk?) stuk code in de comments. Waarom staat dit in de comments? Hoe kan dit nog werken als dit in de comments staat? Hebben we dat nog nodig? Er gaan ineens heel veel vragen door je hoofd.

Hier is een eenvoudige regel voor: als er code in comments staat, heb je die code niet nodig. Hier ben ik meestal redelijk cru in en ik zal het stuk code waarschijnlijk ook gewoon verwijderen als ik dit zie. Zo is het probleem meteen opgelost.

Wat als je dat stukje code toch nog nodig hebt? Wel, daar heb je git voor!

Creëer goede comments

In plaats van code in je comments te zetten, focus je beter op het schrijven van duidelijke comments die de code helpen begrijpen voor je toekomstige zelf en je collega’s.

Houd deze twee regels steeds in je achterhoofd bij het schrijven van comments:

  • Onderschat niet hoe moeilijk het is om een blok code te begrijpen
  • Houdt het kort, developers zijn lui en zullen grote blokken tekst snel vermijden.

Is het te moeilijk om te beschrijven wat er gebeurt in 1 of 2 zinnen? Dan is je functie misschien een beetje te groot en moet je misschien denken aan refactoring.

Conclusie

Houdt gewoon in je achterhoofd dat jij waarschijnlijk niet de enige bent die de code gaat lezen en ermee werken. Schrijf je code meteen duidelijk en volg de afspraken van je team. Dan komt alles goed.