Behoud het overzicht: commentaar in je code
Bij het werken aan complexe applicaties of grote websites zal het meer dan eens voorkomen dat je denkt: "waar stond dat toch ook alweer?". En als andere mensen dan de code ook nog moeten kunnen begrijpen, zijn de rapen gaar. Tijd voor wat overzicht in je code...
Inleiding
Commentaar geven op je code kan erg handig zijn, vooral als je werkt met ingewikkelde functie's in server-side scriptingtalen zoals PHP. Op deze manier kun je er voor zorgen dat ook andere mensen de code kunnen begrijpen en eventueel mee kunnen werken aan de ontwikkeling van een applicatie of website.
Voor alle belangrijke script- en opmaaktalen zijn er opmaakcodes of -tags beschikbaar. In dit artikel bespreken wij deze codes voor XHTML, CSS, PHP en Javascript.
(X)HTML
Voor het plaatsen van commentaar in (X)HTML-code, kun je de volgende code gebruiken:
CSS
Voor het plaatsen van commentaar in CSS-code, kun je de volgende code gebruiken:
advertentie
PHP
Bij PHP-code heb je twee manieren om commentaar toe te voegen. De volgende code is slechts geschikt voor één regel, of voor plaatsing achter een commando:
Het is echter ook mogelijk commentaar te plaatsen voor meerdere regels. Deze code is hetzelfde als de code die je gebruikt voor CSS-commentaar:
Javascript
Ook bij Javascript is het mogelijk commentaar te plaatsen. Dit werkt precies hetzelfde als bij PHP:
