Program-kommentar
Kommentarer i et program
Ideen med at skrive kommentarer i program-kode er at kunne skrive noget ind, der ikke har indflydelse på programmets funktion og opførsel, men som skal gøre det lettere at læse program-koden.
Hvornår skriver man kommentarer
Det er altid en god ide at skrive kommentarerne i forbindelse med at at skriver koden, og ikke vente til man har skrevet hele programmet færdigt.
Man skal passe på man ikke skriver for mange kommentarer, så bliver koden også svær at sætte sig ind i, så man skal skrive det der er nødvendigt, og ikke mere.
Hvem skriver man til?
Man skriver dem i første omgang til sig selv, men ideen er at kommentarerne skal være så generelle at andre kan læse kommentarerne og forstå ideen i koden.
Det betyder at det er en god ide at skrive noget om de overordnede ideer i programmet, samt at dokumentere hvad de enkelte dele af koden laver.
Overordnet set, så skal kommentarerne sørge for at andre kan overtage koden og vedligeholde den, og udvide programmet, uden at man skal skrive for meget om.
Kommentarerne kan også være rigtigt gode, når man skal rette noget i et program efter et eller flere år.
Kommentarer i javaScript
Der er to forskellige måder at skrive kommentarerne på:
En kommentar der dækker resten af linjen som f.x.
// Her kommer alle variabler
var tid = 0; // Denne variabel indeholder tiden fra starten af programmet i sekunder
var sted = 10;Hvis man har en længere beskrivelse, så kan man skrive et kommentarfelt der dækker over flere linjer som vist her:
/* Dette er en længere kommentar
Den starter med slash-stjerne
Den kan strække sig over flere linjer
Man skal bare huske at afslutte den
Det gør man med stjerne-slash
*/Kommentarer i andre sprog
Langt de fleste programmeringssprog.
I C og de C-afledte sprog er det den samme syntaks som i javascript, der jo også stammer fra C
Andre sprog bruger selvfølgelig andre måder at lave kommentarer på, men ideen er den samme.
Kommentarer i HTML omtales under HTML Kommentar.
Alternativer
Man kan gøre meget for at gøre sin kode læselig ved at bruge indrykninger, så man fremhæver strukturerne. Man kan også skille koden ad i forskellige dele ved at funktionsopdele koden fornuftigt, så det bliver overskueligt.
Endelig kan man bruge sigende navne til variabler, funktioner og objekter.