Först, en bild på en utskrift från mitt kontor för att göra posten lite mer trevlig. Den intresserade kan kolla på den här sidan.
Nu till ämnet. Kod är lite annourlunda jämtemot mycket annat här i världen. Om en snickare gör en dålig stol, så är den obekväm eller går sönder efter ett tag. Allt för ofta bedömer dock din arbetsgivare och dina kunder din kod på samma sätt, gör den det den skall? Men kod har fler dimensioner, kunden skall inte bry sig om detta men företaget är en annan femma.
Låt oss först säga vad kod är. Kod är som ett recept, du utför ett antal steg och får ett resultat. Kunden ser resultatet, inget mer. Som ni förstår kan man skriva ett recept på olika sätt och med olika medel. Man kan göra snabba minnesanteckningar för sig själv, eller rigorösa beskrivningar för att få in det i en kokbok så att vilken klåpare som helst kan förstå. Som med allt annat i denna värld finns det ingen absolut sanning med detta, varje tillfälle har sitt tilvägagångssätt, men vad för krav tycker jag skall ställas på kod som kommer att leva kvar? Vandra från person till person?
Vi programmerare kallar beskrivningar i koden om hur den fungerar och vad den gör samt beskrivningar av programmet i sin helhet för dokumentation. Saknas dokumentation är det inte ämnat för andra och om du försvinner, försvinner kunskapen om det du skapat. Den som kommer efter får leka arkeolog som skall förstå en struktur som antas finnas. Det tar tid och det är inte kul. Jag förstår att situationen är oundviklig, vid stress och press. Men man gör i min mening ett dåligt byte av tid, för det slår tillbaka. Chefer borde verkligen trycka på detta, för god kod är inte bara resultat och det varje programmerare skall se det som minst lika viktigt att dokumentera som programmera. Detta skall sedan samlas på ett överskomment vis och göras tillgänglig. I en perfekt värld i varje fall, men vi vet väl alla hur det är med den saken.
No comments:
Post a Comment