Meer informatie Verberg melding

Codereviews en codestandaarden

Duurzame websystemen bouwen dankzij codereviews

Het programmeren van webapplicaties is een teamsport. Goede interne afspraken, vastgelegd in codestandaarden vormen daar de basis voor. Alleen op deze manier is een portal of applicatie door het hele team te onderhouden, ook is het eenvoudiger om uitbreidingen te (blijven) maken. Het checken van opgeleverd werk op codestandaarden gebeurt automatisch via de build server, maar ook in een codereview door een teamlid – het verwerken van eventuele feedback gebeurt natuurlijk door de programmeur zelf.

Wat zijn codereviews?

Codereviews zijn handmatige checks door een mede-teamlid op opgeleverde code. Het is dus een peerreview van een collega die checkt of hij snapt wat er gebeurt in de nieuwe of aangepaste code, en of deze in lijn is met de afspraken die we als team hebben gemaakt. Het aanvragen van zo’n codereview gebeurt altijd vóórdat de code daadwerkelijk is toegevoegd aan de webapplicatie, zo weten we namelijk zeker dat er minder fouten ontstaan.

Nieuwe code wordt altijd toegevoegd via versiebeheer – software die ervoor zorgt dat de versies van een webapplicatie inzichtelijk zijn. Elke toevoeging of wijziging van code door een programmeur zorgt voor een nieuwe versie in versiebeheer,  zo wordt dus ook automatisch een teamlid gevraagd om deze nieuwe versie van de code te reviewen. Wel zo efficiënt!

Maatwerk21

De voordelen van codereviews

  • De kwaliteit van het eindresultaat is vele malen hoger
  • Een frisse blik zorgt soms voor betere ideeën of een efficiëntere oplossing
  • Learning-on-the-job: ook minder ervaren teamleden kunnen meewerken en in korte tijd veel leren van anderen
  • De initiële tijdsinvestering leidt bij nieuwe uitbreidingen in de toekomst tot behoorlijke tijdsbesparingen

“Codereviews stellen ons programmerteam in staat om elkaar continu van feedback te voorzien, met als grote voordelen dat de webapplicatie enorm aan kwaliteit wint én de teamleden elkaar versterken.”

Peter Paul Keulers
IT manager bij Way2Web

Waar checken we op bij codereviews?

De belangrijkste zaken zijn:

  • Zitten er overduidelijke fouten in de code?
  • Gelet op de oorspronkelijke requirements, wordt aan alle eisen van de opdracht voldaan?
  • Klopt de opgeleverde code met de afgesproken codestandaarden?
  • Moet de set met functionele Behat-tests worden aangepast of toegevoegd?

Wat betekent PSR?

PSR staat voor PHP Standard Recommendation en is één van de codestandaarden die we gebruiken bij Way2Web. Door te voldoen aan deze PHP-standaard is de opgeleverde code uniform aan de webstandaarden en beter onderhoudbaar: immers is het logischer ingedeeld en makkelijker te interpreteren voor programmeurs die niet bij de oorspronkelijke realisatie betrokken waren. Naast PSR hanteren we bijvoorbeeld ook codestandaarden voor SASS, CSS en JavaScript. Zo houden we onze codebase duurzaam en toekomstbestendig.

Meer weten over codereviews en codestandaarden?