Clean code is als een gedicht

Een computerprogramma moet werken zoals bedoeld, maar moet ook leesbaar zijn voor wie het onderhoudt. Die leesbaarheid gaat verder dan begrijpelijkheid. Net als een boek of een gedicht is het ene programma prettiger om te lezen dan het andere. Is Clean code als een gedicht?

De dichteres Judith Herzberg is de meester van de hopla. Die term heeft ze zelf bedacht. Het gaat om korte gedichten, die in een paar zinnen helemaal af zijn: de boodschap is daarmee verteld. Een paar mooie voorbeelden: 

ELKE OCHTEND 

Elke ochtend, tussen het aandoen
van zijn linker- en zijn rechterschoen
trekt zijn hele leven even langs.
Soms komt de rechterschoen er dan
bijna niet meer van. 

JULI 

Ik ben mijn jongen kwijt
goud ga ik voor geritsel
mijn nest zit me te wijd.

NA AFLOOP 

De cake is voor
de levenden. 

The Clean Code

Deze laatste is wel heel kort, maar treft heel subtiel de weemoed en berusting die past bij een uitvaart. Deze kunst van veel zeggen in weinig woorden lijkt alleen in gedichten mogelijk. Hoe mooi zou het zijn als een computerprogramma zich kon laten lezen als een gedicht! 

Sommige talen lenen zich goed om in weinig code veel te zeggen. Vaak wordt het er alleen niet leesbaarder op. In Python kan ik bijvoorbeeld op de volgende manier een lijst vullen met de oneven getallen van 1 tot 100: 

oneven = [ x for x in range(1,100) if ix % 2 == 1 ] 

Zo’n zogenaamde “oneliner” is een leuke oefening voor wie van puzzelen houdt, maar is misschien moeilijk te begrijpen voor met name beginnende programmeurs. 

Wat maakt een programma dan wel goed leesbaar? In zijn boek “The Clean Code” heeft Robert C. Martin een aantal richtlijnen gegeven die helpen om prettig leesbare programma’s te schrijven. Zo’n oneliner zou daarin worden afgeraden, want één van de richtlijnen luidt: “Keep it simple, stupid!”. Complexe code mag interessant overkomen, maar bevordert de leesbaarheid niet.  

De belangrijkste boodschap van Robert C. Martin in zijn boek is dat je zorgvuldig en met empathie om moet gaan met de lezer. Die lezer kan je collega zijn, die het programma moet onderhouden, maar de programmeur moet ook zichzelf te vriend houden: is het over een paar maanden nog steeds duidelijk en prettig leesbaar? 

Enkele richtlijnen die daarbij helpen staan genoemd in deze beknopte samenvatting:  

• Houd je aan standaard conventies, zoals regels over naamgeving die gebruikelijk zijn in een bepaalde taal. 
• De boyscout rule, vooral van belang als je bestaande code onderhoudt: “Always leave the campground cleaner than you found it.” 
• Wees consistent: pak vergelijkbare problemen op dezelfde manier aan. 
• Gebruik duidelijke namen. 
• Houd functies kort en eenduidig. 
• Wees consequent met inspringen in code. 
• Houd variabelen en functies dichtbij waar ze gebruikt worden. 

Er zijn nog veel meer richtlijnen, maar het is vooral de achterliggende boodschap die telt: zorg voor prettig leesbare, misschien zelfs jaloersmakend mooie code: 

AAN LEZERS 

Hoe heerlijk moet het zijn
je in gedichten te begeven
zonder dat schrijnende:
had ik dat maar geschreven. 

__

Dit blog is geschreven door: Marko Draisma, trainer bij Vijfhart

Wil je meer weten over Clean Code?

Bekijk dan de 1-daagse training Clean Code waarin je leert hoe je zelf makkelijk te begrijpen, zelf-documenterende code schrijft.