Dataprogrammeringsspråket Microsoft Visual Basic har vært populært i programmeringskretser i mange år. Programmerere bruker den til alle slags prosjekter. Varianter av dette programmeringsspråket brukes til websider, og andre typer Visual Basic -programmer brukes til mange av Windows -programmene vi bruker hver dag. Et av de viktigste elementene i Visual Basic er muligheten til å inkludere kommentarer, som er notater innebygd i koden som ikke har et funksjonelt kodeformål. Visual Basic bruker spesifikk protokoll for å skille disse fra kode. Å legge til kommentarer er ekstremt viktig i de fleste prosjekter for å hjelpe menneskelige kodevisere å lese kodemodulene riktig. Hvis du trenger å legge til kommentarer til Visual Basic, er det noen av de grunnleggende trinnene for å sikre at du gjør dette riktig.
Trinn
Trinn 1. Bestem hvilken type kommentar du vil legge til
Programmerere har flere forskjellige hovedformål med kommentarer som bestemmer det eksakte formatet og stilen til det som skal inkluderes i kommentaren.
- Vurder kodemodulkommentarer. Modulkommentarer er kommentarer på høyere nivå som vanligvis beskriver de overordnede formålene med kodemodulen, i tillegg til annen informasjon som opphavsrett, forfatterskap og mer.
- Vurder behovet for prosedyrekommentarer. Ulike funksjonskodeprosedyrer bør også kommenteres. Prosedyrekommentarer vedrører de spesifikke funksjonene til kode, og de hjelper til med å varsle andre programmerere om de eksakte resultatene av en prosedyre i henhold til hvordan den er skrevet.
Trinn 2. Velg detaljerte kategorier av bruk for kodekommentarer
Noen typer kommentarer, som prosedyrekommentarer, kommer også i forskjellige former. Forstå disse forskjellige bruksområdene for å legge til de riktige kommentarene i programmet ditt.
- Vurder bruken av formålskommentarer for prosedyrer. Disse beskriver hva prosedyren gjør.
- Vurder bruken av funksjonskommentarer. Disse vil hjelpe andre til å forstå hvilke verdier som returneres ved prosedyre.
- Inkluder betingede kommentarer. Betingede kommentarer kan beskrive mulige feilbetingelser og feilhåndtering, samt vilkår som må være oppfylt for at koden skal fungere skikkelig.
Trinn 3. Velg et format for kommentarer
Det er også spørsmålet om hvordan du vil legge til kommentarer til bestemte kodelinjer.
- Bruk venstrehendte kommentarer. Disse kommentarene starter til venstre på skjermen og fortsetter hele veien over en linje. Vanligvis må koderen vilkårlig avslutte kommentaren nær høyre side av skjermen, gå ned til en ny linje og fortsette kommentaren.
- Bruk kommentarer på linje. Kommentarer på linje har en apostrof rett etter et stykke kode og plasseres på samme linje.
Trinn 4. Bruk en apostrof til å markere begynnelsen på kommentarene dine
Dette er det viktigste trinnet for å faktisk skrive kommentarer til kode. Apostrofen er den spesifikke tekstprotokollen som Visual Basic -kompilatoren gjenkjenner for kommentarer. Uten dette vil datamaskinen prøve å lese kommentarene som kode.
