Kommentarer

Teori

Oftest arbejder flere mennesker sammen om at udvikle et program. Derfor er det vigtigt, at man supplerer sin kode med kommentarer, så andre forstår hensigten med koden. [1]

Klar overtrædelse af regel nr. 1.

De 9 bud for gode kommentarer [2]:

1. Kommentarer skal ikke gengive koden
2. Gode kommentarer er ikke en undskyldning for dårlig kode
3. Hvis der ikke kan skrives en klar kommentarer, så er der måske et problem med koden
4. Kommentarer bør fjerne forvirring - ikke skabe forvirring
5. Forklar kode som kan se ud til at være overflødigt
6. Indsæt links til oprindelig kode når man “låner”
7. Indsæt links til eksterne kilder når det er relevant (fx en matematisk redegørelse)
8. Tilføj kommentarer når der rettes fejl i koden (hvad og hvordan)
9. Brug kommentarer til at markere ufærdige dele i koden (fx ved TODO)

Jacobs 10. bud: Hvis man skriver gode kommentarer kan det genbruges i logbogen.

Referencer

[1]

J. Buch, “5.5 Kommentarer i koden”, i Programmering, Systime. Tilgængelig hos: https://programmering.systime.dk/?id=202

[2]

E. Spertus, “Best practices for writing code comments”, december 2021. https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/