Commentaar, info of notities in je code achterlaten
Een tijdje terug kreeg ik een aanvraag binnen om een website opgebouwd in PHP te updaten en enkele aanpassingen in aan te brengen. De webdesigner die de website had opgebouwd kon dit niet langer meer te doen. Na een afspraak met de eigenaar had ik beloofd om zijn website te bekijken of hetgeen hij verlangde mogelijk was.
Wat bleek nu het geval te zijn… De vorige webdesigner had wel goed werk afgeleverd maar had nergens bij zijn PHP code ook maar één regel commentaar of info achter gelaten. Toch niet zo erg denk je dan? Bij een website van enkele pagina’s is dit inderdaad niet zo erg om uit te zoeken. Deze website bestond uit 115 files met code! Een immense en haast onmogelijke zoektocht om dit uit te dokteren. Heel wijs heb ik dan ook vriendelijk bedankt voor deze opdracht.
Een goede raad… Maak je een website in opdracht van iemand laat dan altijd een korte info of comment achter bij de belangrijke blokken in je code. Even overlopen hoe je dit doet :
In HTML
<!-- Laat hier commentaar achter -->
In CSS
/** Laat hier commentaar achter **/
In PHP
// Laat hier commentaar achter, niet langer dan 1 regel
/* Laat hier commentaar achter, over meerdere regels */
# Commentaar in shell stijl
:
Indien je het nuttig vond mag je altijd een bericht achterlaten of u inschrijven op onze nieuwsbrief om altijd op de hoogte te blijven.
Comments
Nog geen reacties.
Plaats een reactie