Technology

Goed opgekuist is half gewonnen met Clean Code

By 2 oktober 2017 juni 20th, 2019 No Comments

Elke ervaren softwareontwikkelaar weet dat zijn codebase proper houden dé belangrijkste manier is om op lange termijn een softwareproject tot een goed einde te brengen. Wij investeren bij Prato veel in de leesbaarheid en de onderhoudbaarheid van onze software. Dit doen we d.m.v. “Clean Code” principes. Deze zijn al langer in de software-industrie aanvaard en worden als onontbeerlijk beschouwd. Praktisch komt het vaak neer op goede communicatie. De termen waar analisten over spreken wil ik, als ontwikkelaar, ook terugvinden in de code, zodat we niet langs elkaar heen praten. Ontwikkelaars die met twee “pairen”, ruimen met wat gezonde discussie mogelijke onduidelijkheden verder uit de weg.

Awareness creëren

In plaats van iedere nieuwe technische collega te onderwijzen in deze principes, leek het ons iets om het probleem bij de wortels aan te pakken: namelijk bij de studenten al wat awareness creëren door les te geven rond clean code principes. Afgelopen vrijdag hebben we bij de PXL het eerste deel van die les mogen geven. Het maakt onderdeel uit van het vak “web & mobile” en stoomt de laatstejaarsstudenten klaar om hun groot groepsproject te kunnen maken. We hebben het tijdens de lessen over clean code principes (leesbaarheid als duidelijke naamgeving, verantwoordelijkheden van functies en objecten, scoping, …) en unit testen.

Het is de bedoeling om studenten iets nuttigs bij te brengen waar ze onmiddellijk baat bij hebben. Daarom heeft de lector ook beslist hun project te beoordelen naar deze principes. Als deze leerlingen terecht komen bij softwarebedrijven zoals Prato, hebben ze al een beetje van deze mantra’s mee en gaan ze zich sneller kunnen inwerken: een win-win situatie voor beide partijen dus! De saai klinkende materie wordt wat bijgekruid met ludieke oefeningen die we in de klas ook gepaired oplossen om de discussie dan al in gang te zetten. In de laatste sessie is het de bedoeling dat men elkaars groepsproject “code reviewt” door er een kritische blik op te werpen en zo snel feedback te kunnen geven. Het komt steeds neer op de feedback loop zo klein mogelijk te maken om stukjes functionaliteit sneller en correcter te kunnen aanbieden aan klanten. Dit principe willen we op deze manier ook overbrengen in plaats van saaie theoretische voorbeelden aan te halen.

Clean code – easy en niet easy:
“code that is easy to understand and easy to change”.

En toch is dat simpel regeltje het allermoeilijkste waar wij, als doorwinterde softwareontwikkelaars, constant tegen botsen. Het is belangrijk dat voor collega’s de code makkelijk te lezen is. Het voorkomt niet alleen irritatie en beperkt tijdverlies, maar maakt het ook gemakkelijker om in de toekomst wijzigingen door te voeren.

Hopelijk hebben de studenten hier toch iets van in hun langetermijngeheugen “gesaved”. Dit is reeds het tweede jaar dat we deze gastcolleges mogen geven aan de PXL en ik merk toch dat het leeuwendeel van de aanwezigen enthousiast oplet. Dat is voor mij al een indicatie dat het de moeite waard is om dit onderwerp op zo’n manier aan te reiken.

Voor de geïnteresseerden of degenen die herhaling nodig hebben zijn de slides beschikbaar op http://cleancode.prato.be/.

Deze website maakt gebruik van cookies om je gebruikservaring te optimaliseren. Door op “Accepteren” te klikken of door gebruik te blijven maken van deze website, ga je akkoord met het plaatsen van deze cookies.