Code review¶
Inleiding¶
Code reviews vormen een cruciale pijler in het softwareontwikkelingsproces. Ze zijn essentieel om de kwaliteit van de code te waarborgen, fouten vroegtijdig op te sporen en te corrigeren, en een cultuur van samenwerking en continue verbetering te bevorderen. Hieronder een opsomming die de relevantie van code reviews inzichtelijk maakt.
- Kwaliteitsborging en foutdetectie
- Kennisdeling en groei van ontwikkelaars
- Consistentie in codestandaarden
- Beveiliging en kwetsbaarheidsdetectie
- Constructieve feedback en verbeteringen
- Probleemoplossing en samenwerking
- Verantwoordelijkheid en transparantie
- Kwaliteitscontrole in agile omgevingen
- Documentatie en kennisbehoud
Code review - Template¶
Bespreek de volgende vragen met de reviewer:¶
Wat heb ik gedaan dat iemand anders zou willen overnemen?¶
Beantwoord hier de vraag.
Is de code makkelijk te begrijpen voor iemand die niet bekend is met het project?¶
Is de code leesbaar en begrijpelijk?
Controleer of de code duidelijk is geschreven, met zinvolle variabelen en functienamen. Kan iemand met weinig kennis van het project de code begrijpen?
Beantwoord hier de vraag.
Zijn de code conventies gebruikt?¶
Bekijk of de code consistent is met de codestandaarden van het project.
Bijvoorbeeld:
- Benaming van functies en variabelen
- Code indentatie
- Code regellengte
- Magic numbers
- Commentaar
Beantwoord hier de vraag.
Zit er niet teveel herhaling in de code?¶
Welke code lijkt zich te herhalen? Kan je de code bijvoorbeeld vervangen door gebruik te maken van functies, loops of classes?
Is de code efficient?¶
Is er onnodige complexiteit? Zie je vereenvoudiging van berekeningen, aantal expressies/stappen dat nodig is? Beantwoord hier de vraag.
Is de bijbehorende documentatie aanwezig, duidelijk en compleet?¶
Beantwoord hier de vraag.
Beantwoord de volgende vragen zelf:¶
Welk deel van mijn code ben ik het meest trots op en waarom?¶
Beantwoord hier de vraag.
Waarin wil ik mij de volgende sprint ontwikkelen m.b.t. code?¶
Beantwoord hier de vraag.
Copy & Paste¶
## Code review - Template
### Bespreek de volgende vragen met de reviewer:
#### Wat heb ik gedaan dat iemand anders zou willen overnemen?
Beantwoord hier de vraag.
#### Is de code makkelijk te begrijpen voor iemand die niet bekend is met het project?
Is de code leesbaar en begrijpelijk?
Controleer of de code duidelijk is geschreven, met zinvolle variabelen en functienamen. Kan iemand met weinig kennis van het project de code begrijpen?
Beantwoord hier de vraag.
#### Zijn de code conventies gebruikt?
Bekijk of de code consistent is met de codestandaarden van het project.
Bijvoorbeeld:
- Benaming van functies en variabelen
- Code indentatie
- Code regellengte
- Magic numbers
- Commentaar
Beantwoord hier de vraag.
#### Zit er niet teveel herhaling in de code?
Welke code lijkt zich te herhalen?
Kan je de code bijvoorbeeld vervangen door gebruik te maken van functies, loops of classes?
#### Is de code efficient?
Is er onnodige complexiteit? Zie je vereenvoudiging van berekeningen, aantal expressies/stappen dat nodig is?
Beantwoord hier de vraag.
#### Is de bijbehorende documentatie aanwezig, duidelijk en compleet?
Beantwoord hier de vraag.
### Beantwoord de volgende vragen zelf:
#### Welk deel van mijn code ben ik het meest trots op en waarom?
Beantwoord hier de vraag.
#### Waarin wil ik mij de volgende sprint ontwikkelen m.b.t. code?
Beantwoord hier de vraag.