Datorprogrammeringsspråket Microsoft Visual Basic har varit populärt i programmeringskretsar i många år. Programmerare använder den för alla slags projekt. Varianter av detta programmeringsspråk används för webbsidor och andra typer av Visual Basic -program används för många av de Windows -program som vi använder varje dag. En av de väsentliga delarna i Visual Basic är möjligheten att inkludera kommentarer, som är anteckningar inbäddade i koden som inte har ett funktionellt kodsyfte. Visual Basic använder ett specifikt protokoll för att skilja dessa från kod. Att lägga till kommentarer är oerhört viktigt i de flesta projekt för att hjälpa mänskliga kodare att läsa kodmodulerna korrekt. Om du behöver lägga till kommentarer till Visual Basic, här är några av de grundläggande stegen för att se till att du gör detta korrekt.
Steg
Steg 1. Bestäm vilken typ av kommentar du vill lägga till
Programmerare har flera olika huvudsyften för kommentarer som bestämmer det exakta formatet och stilen för vad som kommer att ingå i kommentaren.
- Tänk på kodmodulkommentarer. Modulkommentarer är kommentarer på högre nivå som vanligtvis beskriver kodmodulens övergripande syften, liksom annan information som upphovsrätt, författarskap och mer.
- Bedöm behovet av förfarandekommentarer. Olika funktionskodförfaranden bör också kommenteras. Procedurkommentarer avser kodens specifika funktioner, och de hjälper till att varna andra programmerare om de exakta resultaten av ett förfarande enligt hur det skrivs.
Steg 2. Välj detaljerade kategorier av användning för dina kodkommentarer
Vissa typer av kommentarer, som procedurkommentarer, finns också i olika former. Förstå dessa olika användningsområden för att lägga till rätt typ av kommentarer till ditt program.
- Bedöm användningen av ändamålskommentarer för förfaranden. Dessa beskriver vad proceduren gör.
- Tänk på användningen av funktionsreturvärdekommentarer. Dessa hjälper andra att förstå vilka värden som returneras genom procedur.
- Inkludera villkorade kommentarer. Villkorade kommentarer kan beskriva möjliga felvillkor och felhantering, samt villkor som måste uppfyllas för att koden ska fungera korrekt.
Steg 3. Välj ett format för kommentarer
Det finns också frågan om hur du lägger till kommentarer till specifika kodrader.
- Använd vänsterhänta kommentarer. Dessa kommentarer börjar till vänster på skärmen och fortsätter hela vägen över en linje. Vanligtvis måste kodaren godtyckligt avsluta kommentaren nära höger sida av skärmen, gå ner till en ny rad och fortsätta kommentaren.
- Använd in-line kommentarer. In-line kommentarer har en apostrof direkt efter en kodbit och placeras på samma rad.
Steg 4. Använd en apostrof för att markera början på dina kommentarer
Detta är det viktigaste steget för att faktiskt skriva kommentarer i kod. Apostrofen är det specifika textprotokoll som Visual Basic -kompilatorn känner igen för kommentarer. Utan detta kommer datorn att försöka läsa kommentarerna som kod.
