Muligheten til å legge til kommentarer til koden din kan bidra til å forbedre lesbarheten for deg og andre utviklere som kan lese og bruke koden din.
Hvordan fungerer kommentarer?
Kommentarer er ikke noe spesielt. De er bare et sett med teksttegn som beskriver hvordan eller hva et stykke kode gjør.
Kommentar bruker spesialtegn som får kompilatoren til å ignorere dem. La oss diskutere hvordan vi kan implementere og bruke kommentarer i programmene våre.
Rustkommentarer
Det er tre typer kommentarer i rust:
La oss diskutere.
Enkle linjekommentarer
Enkle eller linjekommentarer er den typen kommentarer som spenner over en enkelt linje. De brukes hovedsakelig til å sette inn en kort og beskrivende melding i en kodeblokk.
I rust kan vi sette inn en-linje kommentarer ved hjelp av doble fremover-skråstegn. Et eksempel er som vist:
fn main ()Som nevnt spenner en enkeltlinjekommentar en enkelt linje. Som vist i eksemplet, ignorerer Abovethe Compiler linjen etter8 de to fremover -skråstrekene.
Blokkerer kommentarer
Den andre typen kommentarer er kjent som blokkeringskommentarer. Disse ligner på enkle
Sttart ved å åpne kommentarblokken med en fremover skrå karakter og en stjerne, som (/*).
Etter det kan vi legge til kommentarteksten og lukke kommentarblokken med en stjerne og tilbakeslag som (*/).
Et eksempel på en blokkkommentar i rust er som vist:
fn main ()Koden over viser å lage en blokkeringskommentar som spenner over flere linjer.
Doc kommenterer
Rust gir oss også Doc -kommentarer. Det er to hovedtyper av DOC -kommentarer i rust:
Indre doktor kommentarer
Inner DOC -kommentarer er betegnet med en dobbel fremover -skråstrek og et smell som //!. De er skrevet i en kodeblokk brukes hovedsakelig til å generere dokumentasjon for en kode i en spesifisert blokk.
Et eksempel er som vist:
fn main ()Koden over betegner en indre DOC -kommentar.
Ytre doktor kommentar
Som navnet antyder, refererer en ytre DOC -kommentar til en kommentar rundt en ytre kodeblokk og fungerer som dokumentasjon for den blokken.
Ytre doktor kommentarer er betegnet med trippel fremoverstrøk. Et eksempel vises:
/// hovedfunksjonKonklusjon
Denne artikkelen hjelper deg å forstå forskjellige typer kommentarer i rust og hvordan du lager korte og beskrivende meldinger for kodeblokkene dine.
Vi håper du likte artikkelen, takk!