Opmerkingen in Code (Visual Basic)
Terwijl u de codevoorbeelden leest, ziet u vaak het opmerkingsymbool ('). Dit symbool geeft aan dat de Visual Basic-compiler de volgende tekst of de opmerking negeert. Opmerkingen zijn korte verklarende notities die zijn toegevoegd aan code ten behoeve van degenen die deze lezen.
Het is een goede programmeerpraktijk om alle procedures te beginnen met een korte opmerking waarin de functionele kenmerken van de procedure worden beschreven (wat het doet). Dit is voor uw eigen voordeel en het voordeel van iedereen die de code onderzoekt. U moet de implementatiedetails (hoe de procedure dit doet) scheiden van opmerkingen die de functionele kenmerken beschrijven. Wanneer u implementatiedetails in de beschrijving opneemt, moet u deze bijwerken wanneer u de functie bijwerkt.
Opmerkingen kunnen een instructie op dezelfde regel volgen of een hele regel in beslag nemen. Beide worden geïllustreerd in de volgende code.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Als uw opmerking meer dan één regel vereist, gebruikt u het opmerkingsymbool op elke regel, zoals in het volgende voorbeeld wordt geïllustreerd.
' This comment is too long to fit on a single line, so we break
' it into two lines. Some comments might need three or more lines.
Richtlijnen voor opmerkingen
De volgende tabel bevat algemene richtlijnen voor de typen opmerkingen die vooraf kunnen gaan aan een sectie met code. Dit zijn suggesties; Visual Basic dwingt geen regels af voor het toevoegen van opmerkingen. Schrijf wat het beste werkt, zowel voor u als voor iedereen die uw code leest.
| Type opmerking | Beschrijving van opmerking |
|---|---|
| Doel | Beschrijft wat de procedure doet (niet hoe het werkt) |
| Aannames | Geeft een lijst weer van elke externe variabele, besturingselement, open bestand of ander element dat wordt geopend door de procedure |
| Effecten | Geeft een lijst weer van elke betrokken externe variabele, besturingselement of bestand en het effect dat het heeft (alleen als dit niet duidelijk is) |
| Invoerwaarden | Hiermee geeft u het doel van het argument |
| Retouren | Hierin worden de waarden uitgelegd die door de procedure worden geretourneerd |
Onthoud de volgende punten:
Elke belangrijke variabeledeclaratie moet worden voorafgegaan door een opmerking waarin het gebruik van de variabele wordt beschreven die wordt gedeclareerd.
Variabelen, besturingselementen en procedures moeten duidelijk genoeg worden genoemd dat opmerkingen alleen nodig zijn voor complexe implementatiedetails.
Opmerkingen kunnen geen regelvolgorde op dezelfde regel volgen.
U kunt opmerkingensymbolen voor een codeblok toevoegen of verwijderen door een of meer regels code te selecteren en de knoppen Opmerking (
) en Opmerkingen (
) op de werkbalk Bewerken te kiezen.
Notitie
U kunt ook opmerkingen aan uw code toevoegen door de tekst met het REM trefwoord te voorafgaan. ' Het symbool en de/ opmerkingenknoppen zijn echter gemakkelijker te gebruiken en vereisen minder ruimte en geheugen.
