Det er mye som er vanskelig med programmering, navngivning kommer høyt opp på lista. Hvorfor er det vanskelig, og hva kan du gjøre med det? Her er et hendig flytdiagram som kan hjelpe deg.
Det er et kjent sitat i IT-bransjen du som programmerer sikkert har hørt før: “Det er bare to ting som er vanskelig i informatikk: cache invalidering og navngivning” [1]. Likt alt annet på internett er det folk som ikke er enig i denne påstanden, og ønsker å bidra med sin egen variant. Min personlige favoritt er: “Det er bare to ting som er vanskelig i informatikk: cache invalidering, navngivning og bomme-med-én-feil” [2]. I andre varianter av denne vitsen, blir cache invalidering gjerne byttet ut med teknologien forfatteren liker best, og bomme-med-én-feil med et forsøk på en morsommere punchline.
Men navngivning er alltid med.
For navngivning er både en viktig og vanskelig del av profesjonen vår. Det er viktig fordi det er her du som utvikler har muligheten til å gjøre problemet forstått av fremtidige lesere, en leser som kan være alt fra deg selv som har glemt mye siden sist, til en kollega som ikke lenger har tilgang til å spørre deg hva du egentlig tenkte da du skrev koden. Det er også viktig fordi ordene du bruker i koden sprer seg til resten av teamet når du snakker om problemet du løser. Hvis brukerne dine benytter andre ord for de samme tingene, da har du rigget deg opp for mange misforståelser.
Navngivning er vanskelig fordi det ikke finnes noe entydig rett svar, og det som fungerer i dag ikke nødvendigvis fungerer i morgen. Det er vanskelig fordi du har en helt annen forståelse når du allerede har løst problemet og navngir, enn når du ikke vet noe og skal bruke navnet til å orientere deg og skjønne hva som egentlig er greia. Og ikke minst er det vanskelig fordi det er mulig å ha forskjellig oppfatning av samme ord eller begrep.
Du har muligheten til å formidle på alle steder der tekst brukes: variabler, funksjoner, tester, topics, apier, filer, applikasjonsnavn osv. Her kan du kommunisere intensjon, skape en forståelse av problemet du løser, og bidra til å styrke et felles språk i teamet som dere kan bruke til å fortsette å bygge og videreutvikle produktet dere lager.
Etter rundt to tiår med diskusjoner, feilskjær og dyrekjøpte erfaringer har jeg samlet opp tips og triks som er nyttige å ha når du sliter med å navngi tingen din. Jeg har komprimert de ned i et gøy flytdiagram slik at du kan få hjelp til å skrive lesbar kode, og kanskje kjenne deg igjen i situasjonene og le litt av smerten som ligger i det å navngi.
Vær så god!
[1] Internett er stort sett enige om at Phil Karlton sa dette først.
[2] Leon Bambrick hevder han la til “bomme-med-én”