nästa upp förra
Nästa: Installationskommentar Upp: cdok Konventioner för kommentarer Förra: cdok Konventioner för kommentarer

Kommentartyper

Kommentarer i källkod kan delas in i olika grupper efter form och funktion. De vanligaste typerna redovisas nedan. Avvik inte från detta sätt att kommentera om du inte har en väldigt bra anledning. Vi går även igenom ett fåtal dokumentationstyper som normalt inte ligger i källkodsfiler, men som är viktiga för programmerare och användare av programmen.

Oavsett vilken kommentartyp det rör sig om; om du tar vid där någon annan slutat, så lägg till ditt namn i AUTHOR-delen. Ta inte bort det/de namn som står där innan. Om du inte har tagit vid efter andra personer rakt av, men dokumentet/kommentaren är inspirerad av eller har klara likheter med något som någon annan har gjort; skriv det. Låtsas inte om som om det är du som har hittat på allt från början till slut, om du har fått mycket från annat håll.

Alla rena C-kommentarer som står på yttersat nivån (d.v.s. börjar i kolumn 1), ska ha ett unikt ord som första ord. Detta för att underlätta automatisk hantering av dessa kommentarer.

Tänk på att kommentarer är facklitteratur. De ska inte förklara vad programmering handlar om, eller hur programspråket man använder fungerar (om det inte är väldigt mörka hörn av språket man befinner sig i). Kommentarer ska förklara vad respektive hur.



Jonas Mölsä
Sat Sep 13 13:46:34 MET DST 1997