Waarom het benoemen van elementen in development zo belangrijk (en moeilijk) is

Wil je deze blogpost graag in het Engels lezen? Snap ik. Alsjeblieft!

Gedurende de periode dat ik developer ben, kwam ik regelmatig vast te zitten bij het benoemen van een klasse of functie. Soms werd het zelfs zo erg dat ik in mijn ‘side projects’ de interesse in het volledige project verloor, omdat ik er maar niet uitkwam wat de naam van het project moest zijn. Ook al had ik een heel duidelijk idee in mijn hoofd van wat het doel van het project was.

Zo wou ik bijvoorbeeld ooit een tool bouwen waarin je meerdere Github repositories kon kiezen. Deze zou dan alles samenvoegen tot één feed met alle commits, PR's, issues, enz. Maar ik kon er niet achter komen hoe ik de tool moest noemen. Uiteindelijk heb ik hem nooit gebouwd.

Ik zou het stukje code of project in kwestie heel makkelijk een tijdelijke naam kunnen geven. Maar laten we eerlijk zijn… Een tijdelijke naam blijft niet tijdelijk, want die naam wordt waarschijnlijk de blijvende naam.

Waarom het zo belangrijk is om code een goede naam te geven

Het primaire doel van je code is het verminderen van de complexiteit. Het kiezen van duidelijke namen helpt daarbij. Het benoemen van iets, een functie, klasse of zelfs een variabele kan het zo veel makkelijker maken om jouw code te begrijpen. Hierdoor verhoogt ook de mate waarin je code onderhouden kan worden. Zeker als je niet de enige developer bent die aan dat stuk software werkt. 

Ik denk dat de meeste developers het erover eens zijn dat de variabele "$a" niets zegt over wat voor soort data die variabele bevat, terwijl "$validLoggedInUser" heel duidelijk zegt wat je kunt vinden in die variabele.

Hoe je code benoemen?

Er zijn een aantal dingen die je kunt doen om te voorkomen dat je vast komt te zitten bij het benoemen van elementen in je code.

Maak gebruik van een thesaurus
Het eerste dat je kunt proberen is het gebruiken van een thesaurus. Een thesaurus of synoniemenlijst geeft je - zoals het woord al doet vermoeden - een lijst met synoniemen voor het woord dat je zoekt. Dit resulteert vaak in een concreet idee voor je naam. Ik gebruik hier meestal Powerthesaurus voor.

Vraag een tweede mening
Nadat je een thesaurus hebt geprobeerd, vraag je best aan bevriende of collega developers hoe zij dat bepaalde element zouden benoemen. En of de naam die jij bedacht hebt, beschrijvend genoeg is. De naam waarvan jij dacht dat die precies omschreef wat je bedoelde, is misschien niet zo duidelijk als je dacht. Een tweede perspectief is daarom altijd zeer waardevol.

Laat het even rusten
Als de tijd het toelaat, is het aangeraden om je code een dag of twee te laten rusten. Zo kun je de code nadien bekijken met een fris perfectief. Dan zie je of de naam die je hebt gekozen net wel of net niet beschrijvend genoeg is.

Hou het simpel

Het verminderen van complexiteit, dat is het primaire doel van coderen. Je gekozen naam zou dat dan ook moeten doen. Of je best een korte of lange naam kiest? Dat doet er volgens mij niet toe. Zolang de naam maar beschrijvend genoeg is en de complexiteit van je code vermindert.

Wat is jouw mening over het benoemen van elementen in code? Heb jij bepaalde regels die je hanteert? Laat het me weten op Twitter @yinxes!