Hvordan laver man kommentarer til sin kode?

Af Allan Vebel

Opdateret: 20-10-2011

Hvorfor kommentarer?

Skal jeg lave kommentarer til min kode, eller skal jeg bare lade kode være kode? Det er nok et spørgsmål om stil, om hvorvidt du selv kan finde rundt i koden, og om du skal dele koden med andre.

Er din kode avanceret, eller kan den blive det, eller er der andre der en dag skal overtage den, er det sikkert en god ide at tænke på at lave

til din kode.

Hurtigt at finde

Det kan være et bestemt sted på din side, hvor det er er vigtigt at kunne finde noget hurtigt, der skal rettes jævnligt, eller en tællerkode fra et fremmed sted.


<!-- Tællerkode fra Peak -->

[Tællerkode fra Peak]

<!-- Slut på tællerkode -->

Tænd og sluk for elementer med kommentarkode

Det kan også være et html-element, som er under mistanke for at lave ravage på din side, og som du derfor midlertidigt vil sætte ud af funktion (men uden at slette koden). Eller det kan være et link, der er 'afgået ved døden' og som du lige skal finde en alternativ adresse til.


<!-- <a href="en_adresse">Linktekst</a> -->

Du kan også have kommentarer i din css-kode, det laves på en lidt anden måde:


/* Kommentar */
 
a:hover{

/* color:#f00;

background:inherit; */   /* Koden er midlertidigt slukket */

}

Som sagt er det et spørgsmål om stil - det har ikke nogen praktisk betydning for udseendet af din hjemmeside.

Fejlsøgning

Et område hvor kommentarkoden virkelig har praktisk betydning, er ved fejlsøgning på din side. Jeg har ofte været ude for at en bestemt kode opfører sig mærkeligt i en bestemt browser - her er det fint midlertidigt at kunne udelukke hele koden, eller dele af den med kommentartegnene - og så bare teste igen - finde en løsning - og komme videre.

Laver du anden kode, skal du lave dine kommentarer på nogle andre måder:

asp

Man indsætter en kommentar i et asp-script ved at starte kommentaren med en apostrof. Alt i samme linje efter apostroffen vil fungere som en kommentar.
' Dette er en kommentar

php

Man indsætter en kommentar i et php-script ved at starte kommentaren med 2 skråstreger. Alt på samme linje efter disse skråstreger vil fungere som en kommentar.
// Dette er en kommentar

Man kan i php også indsætte en kommentar på samme måde som i css:
/* Dette er en kommentar */