Commentaar toevoegen aan broncode

Het is een goede gewoonte om aan je broncode van je website commentaar toe te voegen. Niet alleen voor de eventuele bezoeker, die in je broncode kijkt hoe je iets gedaan hebt, maar ook voor jezelf. Je kunt op die manier bij het bouwen of bij het wijzigen van je site makkelijk terugvinden waar iets stond. Zo kun je de indeling van je site weergeven, waar de header stond en waar het menu, maar je kunt ook bepaalde functies weergeven in een javascript.

Commentaar toevoegen

Nu is het toevoegen van commentaar voor elke programmeertaal weer net even anders. Daarom hier een overzicht hoe je commentaar toevoegt aan html, CSS, javascript en PHP.

Commentaar in HTML en XHTML

Commentaar toevoegen aan HTML en XHTML gaat op de volgende manier

<!-- Daarna commentaar toevoegen tot en met de sluittag. -->

Je begint dus met <!--, handig is om daarna een spatie open te laten. Merk op dat deze commentaarcode ook gebruikt wordt
als je een intern stylesheet maakt. Alles wat na deze openingstag komt wordt genegeerd door de browser, totdat er een sluittag
komt, wederom eerst een spatie, daarna -->.

Commentaar in CSS

Ook binnen een stijlblad kan wat commentaar toevoegen heel handig zijn. Zo kun je precies aangeven waar een bepaald
onderdeel van je stylesheet voor dient.

/* Alinea die vetgedrukt staat */

Zoals je ziet is een commentaarregel in CSS anders dan in HTML. Alles wat na een /* staat wordt genegeerd totdat de browser
*/ tegenkomt.

Commentaar in JavaScript

In JavaScript kun je op twee manieren commentaar toevoegen. Je kunt een regel commentaar toevoegen en een blok commentaartekst.
Dat gaat als volgt.

// Alles wat hier staat tot aan het einde van de regel wordt genegeerd.
/* Alles wat hier staat tot aan de afsluiting wordt genegeerd, 
ook al beslaat de tekst die je hebt 
meerdere regels, de afsluiting is */

Een blok komt dus tussen /* en */ te staan, voor een regel commentaar gebruik je //.

Commentaar in PHP

PHP heeft ook meerdere manieren om commentaar toe te voegen. De eerste is weer voor een blok tekst, namelijk van /*
tot en met */. Dit kan over meerdere regels. Daarnaast heb je commentaar voor 1 regel, een hekje (#) of twee slashes (//).
Voorbeelden:

/* Commentaar in een PHP sript dat meerdere
regels kan beslaan ziet er zo uit */
# Commentaar voor 1 regel
// Commentaar voor een andere regel
$average = $orderTotal/$nItmes // Commentaar achter een specifieke opdracht.