Det finns många åsikter om hur bra programkod ska se ut. Det är svårt att hitta en sammanhållen regelsamling som är giltig för samtliga populära språk, men det finns gott om samlingar med goda råd, av varierande kvalitet.
En sådan regelsamling som håller hög kvalitet är Ryan McDermotts Clean Code Javascript som finns publicerad på Github. Även om den är avsedd för Javascript och all exempelkod är skriven i det språket så är reglerna i hög grad giltiga för många andra språk.
Läs också: 6 oskrivna regler för alla öppen källkod-projekt
Clean Code Javascript är omfattande, både vad gäller antal områden som berörs och det totala antalet regler, men de enskilda exemplen är väl avgränsade. Det stämmer bra överens med den regel som, översatt till svenska, beskrivs som den viktigaste vad gäller funktioner. Nämligen att en funktion ska göra en sak.
Ett smakprov på en regel är att man ska använda variabelnamn som är sökbara. Det exemplifieras visserligen med en konstant, men poängen framgår ändå. Istället för att skriva:
setTimeout(blastOff, 86400000);
Bör man skriva, till exempel:
setTimeout(blastOff, MILLISECONDS_IN_A_DAY);
MILLISECONDS_IN_A_DAY är förstås en konstant som fått värdet 86400000.
Läs också: Utvecklare – det här behöver du ha koll på 2017
Det här var ett av de kortare och enklare kodexemplen i regelsamlingen, men det beskriver hur den är uppbyggd på ett bra sätt.
En sak är säker, om du anammar alla regler i Clean Code Javascript så kommer du att skriva snygg, lättläst och lättbegriplig Javascriptkod. Att det är föga troligt att någon Javascriptutvecklare förutom Ryan McDermott gillar precis alla regler i samlingen är ett mindre problem. Hans regelsamling är verkligen bra nog ändå.
