Tobias was onlangs op de conferentie Jcon in Keulen. Daar waren twee presentaties die goed op elkaar aansloten over hoe je beter wordt in het lezen van code en hoe je beter code reviews voor een pull request kunt doen. Hieronder lees je de tips die Tobias uit de presentaties heeft gehaald.

Als ontwikkelaar lees je vaak meer code dan dat je schrijft. Het verbeteren van je vaardigheid om code te lezen is daarom essentieel. Gelukkig kun je deze vaardigheid oefenen, net zoals je dat zou doen in een boekenclub, maar dan met code.

Waarom is code lezen zo belangrijk?

Volgens Felienne Hermans in haar boek The Programmer’s Brain ligt onbegrip van code aan drie dingen:

1. Te weinig informatie voor de lezer: Bijvoorbeeld te weinig commentaar in de code of te weinig context over het project.
2. Te weinig kennis bij de lezer: Bijvoorbeeld onvoldoende kennis van de programmeertaal.
3. Beperking van het menselijke brein: Het is onmogelijk om de hele werking van een applicatie in je hoofd te houden.

Technieken om beter code te lezen

Er zijn verschillende manieren om met onbegrip om te gaan:

• Tabellen en grafieken maken: Visualiseer het project om beter begrip te krijgen.
• Lijst maken van dingen die je niet weet: Noteer onbekende aspecten om later uit te zoeken.
• Code tijdelijk refactoren: Maak de code tijdelijk leesbaarder voor jezelf.
• Iets stuk maken: Probeer de code opzettelijk te breken om te zien wat er gebeurt.

Voor een nieuw project dat je nog niet goed kent, kun je deze stappen volgen:

1. Lees de documentatie en requirements: Begrijp wat de applicatie zou moeten doen.
2. Praat met andere developers: Vraag naar de geschiedenis, omgeving en toekomst van de applicatie.
3. Probeer het project te draaien: Zorg dat je het project kunt uitvoeren voordat je wijzigingen aanbrengt.

Bekijk de structuur in je IDE: Gebruik tools zoals een dependency matrix voor een overzicht

Tips voor betere code reviews

Code reviews zijn een essentieel onderdeel van het ontwikkelproces. Hier zijn enkele tips om ze effectiever te maken uit een presentatie van Hinse ter Schuur:

• Begin met de vraag waarom een wijziging is gedaan: Begrijp de reden achter de codeverandering.
• Bekijk systematisch de codestyle, het design, testen en documentatie: Controleer of de wijziging voldoet aan de standaarden.
• Delen van kennis: Code reviews zijn een kans om kennis uit te wisselen tussen de ontwikkelaar en de reviewer.
• Geef complimenten: Een positieve benadering kan motiverend werken.
• Probeer oplossingen uit in code: Test je suggesties om te zien of ze werken.
• Automatiseer waar mogelijk: Zorg dat compilatie, code style scans, testen en coverage berekening automatisch gebeuren voor de review.
• Review met een ander als er haast is: Vraag om hulp als je nieuw bent op een project en er snel resultaat nodig is.
• Check je eigen werk: Controleer als developer je eigen code voordat je een pull request opent.
• Communiceer bij onduidelijkheden: Ga in gesprek als iets onduidelijk is of veel discussie oplevert.

Door deze technieken en tips toe te passen, kun je je vaardigheden in het lezen van code en het uitvoeren van code reviews aanzienlijk verbeteren. Het resultaat is niet alleen een betere codebase, maar ook een efficiënter en effectiever ontwikkelproces.