Commentaartekens
- 08/11/2011
Inleiding
Dit is een eerder kort artikel over het zetten van commentaarregels in code. Meer specifiek, welke commentaartekens gebruiken we doorgaans?
Over het waarom van het toevoegen van commentaarregels zijn al vele uren tijd en liters inkt besteed, daar hoeven we niet meer op in te gaan. Gewoon een gezonde verhouding van commentaarregels ten opzichte van code-regels, is aan te bevelen. Niet te weinig commentaar, en niet te veel.
Overzicht
Hieronder zet ik de tekens en een voorbeeld voor een aantal omgevingen waarin ik al programmeerde. Dit artikel zal ik zelf ook nog wel eens raadplegen aangezien soms het juiste karakter soms ver te zoeken is bij mij.
| Omgeving | Commentaarteken | Voorbeeld |
| VBA (Office) en VBscript (.vbs) | ' vóór de tekst | ' mijn commentaar |
| Rem vóór de tekst | Rem mijn commentaar | |
| HTML, XML | <!-- vóór de tekst en --> ná de tekst | <!-- mijn commentaar --> |
| CSS | /* vóór de tekst en */ ná de tekst | /* mijn commentaar */ |
| SQL (SQL Server, Oracle, …) | -- vóór de tekst | -- mijn commentaar |
| /* vóór de tekst en */ ná de tekst | /* mijn commentaar */ | |
| Batch files (.bat) | Rem vóór de tekst | Rem mijn commentaar |
| :: vóór de tekst | :: mijn commentaar | |
| TM1 rules en processen | # vóór de tekst | # mijn commentaar |
| MDX in TM1 | -- vóór de tekst, ná de MDX expressie | {} -- mijn commentaar |
| // vóór de tekst, ná de MDX expressie | {} // mijn commentaar | |
| /* vóór de tekst en */ ná de tekst | /* mijn commentaar */ | |
| Excel formules | de N() functie gebruiken | =A1/1000+N("Dit is de omzet in duizendtallen") |
| Eviews | ' vóór de tekst | ' mijn commentaar |
| Stata | * vóór de tekst | * mijn commentaar |
| /* vóór de tekst en */ ná de tekst | /* mijn commentaar */ | |
| C++, PHP, JavaScript, Ajax, … | /* vóór de tekst en */ ná de tekst | /* mijn commentaar */ |
| // vóór de tekst | // mijn commentaar |
De N() functie in Excel negeert tekst: zodoende kan je ongestraft tekst opnemen bij wijze van verduidelijking of commentaar. Al zijn er wellicht wel handigere methoden om dit aan te pakken, ik wilde jullie de functie niet onthouden als ‘wetertje’.
Over het algemeen wordt commentaartekst groen gemarkeerd in vele programmeeromgevingen, tenzij je dit verandert in de Opties/Instellingen/Voorkeuren. Daarom zet ik het ook zo in de tabel hierboven. Bij het uitvoeren van code wordt zulke tekst geheel genegeerd. Je kan er dan ook aanwijzingen, verhelderingen, extra uitleg, testcode, en nog andere in opnemen.
De meeste tools hebben menu-opties of icoontjes op een werkbalk. Dan kan je 1 of meer regels code selecteren (of lege regels) en in 1 beweging commentaartekens toepassen of wegnemen. Nu volgt een schermafdruk waar je rechts bovenaan op de werkbalk iconen ziet om tekst (de selectie) in of uit commentaar te zetten.
Zo, dat was het alweer voor deze keer.
