Commentaar

In html, js en css bestanden kun je uiteraard gewoon commentaar gebruiken zoals dat voor de verschillende talen is vastgelegd in de specficaties:

In html met  inline of over meerdere regels. Voorbeeld:

<p>Een paragraaf <!-- wat hier staat is commentaar en toont de browser niet --></p>
<!-- Deze tekst en ...
<p>...deze pagagraaf is ook niet zichtbaar.</p>
-->

In css met /* ... */ inline of over meerdere regels. Voorbeeld:

body {
  margin: /* dit is commentaar */ 10em;
}
/* de volgende css regel is 'uitgecommentarieerd'
p {
  padding: 12px;
}
*/

In js met // aan het begin of eind van een regel of met /* ... */ inline of over meerdere regels:

function /* dit is inline commentaar */ (msg) {
  // dit is commentaar op een regel
  alert(msg); // dit is commentaar aan het eind
}
/* maar ook zo kun je en regel met commentaar maken */
var x= 123;
/* en zo maak je een functie niet meer beschikbaar
function abc() {
  ...
}
*/

Naast bovenstaande standaard commentaar-mogelijkheden kent het cms ook enkele eigen mogelijkheden:

html-commentaar die begint met een <!--? ... zal het cms uit de html verwijderen voor de html gepubliceerd wordt. Op die manier kun je commentaar opnemen voor jezelf of collega's die expliciet niet getoond moet worden een derden/bezoekers. Voorbeeld:

<!-- dit commentaar blijft gewoon in de broncode van het html bestand staan -->
<!--? dit commentaar zal het cms vooraf verwijderen... -->

Voor javascript en css is deze mogelijkheid ook beschikbaar:

/* dit commentaar blijft gewoon in de broncode staan */
/*? dit commentaar zal het cms verwijderen ... */

Javascript en css bestanden zullen standaard door het cms worden geminified... en daarmee zal sowieso al het commentaar worden verwijderd. Om commentaar expliciet te laten staan (bijv. copyright informatie) dient het te beginnen met /*! ... Voorbeeld:

/*! 
  Copyright
  Dit commentaar zal niet worden verwijderd bij minifyen
*/

NB: neem nooit gevoelige gegevens (wachtwoorden, etc.) op in commentaar dat het cms zal verwijderen. Het cms slaat namelijk wel een kopie op van het bestand met het commentaar. Het zorgt er alleen voor dat het commentaar niet in een gepubliceerde versie van het bestand komt te staan.