2006-11-08

Kommentator

För att det inte bara ska handla om filosofi här så tänkte jag att jag kunde skriva lite om programmering istället.

När man går i skolan och läser datalogi så får man lära sig att man ska kommentera. Gärna på något sätt som det är lätt att ge klara och tydliga instruktioner om, d.v.s. ett sjok text innan varje funktion, där det står vad funktionen gör, hur den gör det och varför. När man varit tvungen att sitta och skriva 10-raders kommentarer till 2-raders funktioner ett tag så vill man bara slippa sen. När man sedan pluggat klart och börjat jobba så låter man bli att skriva kommentarer, om man inte måste. Om man måste så måste man antagligen göra det på ungefär samma sätt, troligtvis i syfte att texten ska matas in i doxygen, javadoc eller något åt det hållet.

De där kommentarerna kan vara trevliga om de finns där, men de är inte speciellt viktiga och har en förmåga att göra koden mer svårläst (dessutom ska man inte behöva förklara att funktionen SpinWheel() snurrar på hjulet, det fattar man av namnet). Vad man inte får lära sig i skolan är när det verkligen är viktigt att skriva kommentarer: när man behöver förklara varför man gör på ett visst sätt, om man gör något som inte verkar helt naturligt, t.ex. någon form av workaround för något bisarrt system som koden ska köras på. Det finns inget sätt att få det att framgå av koden varför man gjort något på ett visst sätt, alltså bör man förklara det. Vad den gör och hur kanske inte är uppenbart, men informationen finns i alla fall där.

3 kommentarer:

UL-Tomten sa...

Programmerar man for clarity behövs det sällan kommentarer. Men ofta programmerar man ju for brevity, eftersom det är roligare.

Word verification: 0bfüsk8

hjon sa...

// Du är min bästa vän och det säger jag inte bara för att jag är full. Jag är inte ens full.

UL-Tomten sa...

Skönt att vi fick det utrett.