Kommentarer i kod (Visual Basic)
När du läser kodexemplen stöter du ofta på kommentarssymbolen ('). Den här symbolen instruerar Visual Basic-kompilatorn att ignorera texten som följer den eller kommentaren. Kommentarer är korta förklarande kommentarer som läggs till kod till förmån för dem som läser den.
Det är god programmeringspraxis att inleda alla procedurer med en kort kommentar som beskriver procedurens funktionella egenskaper (vad den gör). Detta är till din egen fördel och fördelen med alla andra som undersöker koden. Du bör separera implementeringsinformationen (hur proceduren gör det) från kommentarer som beskriver de funktionella egenskaperna. När du inkluderar implementeringsinformation i beskrivningen bör du komma ihåg att uppdatera dem när du uppdaterar funktionen.
Kommentarer kan följa en instruktion på samma rad eller uppta en hel rad. Båda illustreras i följande kod.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Om kommentaren kräver mer än en rad använder du kommentarssymbolen på varje rad, vilket visas i följande exempel.
' 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.
Riktlinjer för kommentarer
Följande tabell innehåller allmänna riktlinjer för vilka typer av kommentarer som kan föregå ett kodavsnitt. Det här är förslag. Visual Basic tillämpar inte regler för att lägga till kommentarer. Skriv det som fungerar bäst, både för dig och för alla andra som läser din kod.
| Kommentarstyp | Kommentarsbeskrivning |
|---|---|
| Syfte | Beskriver vad proceduren gör (inte hur den gör det) |
| Antaganden | Visar en lista över varje extern variabel, kontroll, öppen fil eller annat element som används av proceduren |
| Effekter | Visar en lista över varje påverkad extern variabel, kontroll eller fil och vilken effekt den har (endast om det inte är uppenbart) |
| Indata | Anger syftet med argumentet |
| Returer | Förklarar de värden som returneras av proceduren |
Kom ihåg följande punkter:
Varje viktig variabeldeklaration bör föregås av en kommentar som beskriver användningen av variabeln som deklareras.
Variabler, kontroller och procedurer bör namnges tillräckligt tydligt för att kommentarer endast behövs för komplex implementeringsinformation.
Kommentarer kan inte följa en radfortsättningssekvens på samma rad.
Du kan lägga till eller ta bort kommentarssymboler för ett kodblock genom att välja en eller flera kodrader och välja knapparna Kommentar (
) och Avkommentering (
) i verktygsfältet Redigera .
Kommentar
Du kan också lägga till kommentarer i koden genom att föregå texten med nyckelordet REM . Symbolen ' och kommentarens /avkommenteringsknappar är dock enklare att använda och kräver mindre utrymme och minne.
Se även
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för