Det forbedrer lesbarheten til koden for andre programmerere så vel som for deg selv, slik at du kan gi informasjon om hvor komplekse ting håndteres i programmet for dypere forståelse og vedlikehold. Vi skal utforske de forskjellige typene kommentarer Dart -støtter i denne artikkelen.”
Ulike type kommentarer i en pil i Ubuntu 20.04?
I Dart kan du komme med kommentarer på en rekke måter som følger:
Enkeltlinje kommentarer.
Syntaks: // Enkeltlinje kommentar.Kommentarer med flere linjer.
Syntaks: /* Enkeltlinje kommentar.*/Enkeltlinje dokumentasjonskommentarer.
Syntaks: /// én-linje kommentar.Kommentarer med flere linjer.
Syntaks: /** Enkeltlinje kommentar.*\Hvordan bruke kommentaren i Dart i Ubuntu 20.04?
Mellom DART -uttalelsene kan du legge til kommentarer hvor i programmet. Kompilatoren/tolken avviser bare kommentarene i koden vår, noe som resulterer i ingen endring i programmets endelige utgang. I et nøtteskall fungerer kommentarer som en kort, forståelig forklaring på spesifikk kode. Merk at kommentarer ikke skal brukes til å forklare dårlig skriftlig kode. Forsøk alltid å produsere klar, lesbar kode før du legger til kommentarer. Vi har forskjellige kommentartyper som brukes i Dart -skriptet som følger:
Eksempel nr. 1: Bruke enkeltlinjekommentaren i en pil i Ubuntu 20.04
En enkeltlinjekommentar kommer til uttrykk med doble fremover-slash (//) og bidrar vesentlig til Newline-karakteren. En enkeltlinjekommentar i Dart brukes til å kommentere en linje til den er ødelagt.
Vi har vår første enkeltlinjekommentar som brukes i DART-hoveddelen av koden. Enkeltkommentaren har "området" -formelen, som vi har brukt i variabelen "området.”For å tømme leserne, har vi brukt områdets formel her. Deretter bruker vi igjen en enkeltlinjekommentar for å demonstrere hva som skjer videre i utskriftsfunksjonen.
Du kan legge merke til at en-linjekommentarteksten blir ignorert her av DART-kompilatoren; Bare "området" vises, som vi har passert i utskriftsfunksjonen.
Eksempel nr. 2: Bruke multi-line kommentar i en pil i Ubuntu 20.04
Kommentarer med flere linjer kan brukes når du trenger å legge til kommentarer til mange linjer. Dart Multiline kommentarer brukes til å kommentere hele kodeseksjoner. Det starter og slutter en multi-linjekommentar med henholdsvis “/*” og “*/”, henholdsvis. Mellom delen av multiline kommentarer " / * og * /", ignorerer kompilatoren alt. På den annen side kan ikke en multi-line kommentar pakkes inn i en annen kommentar på flere linjer.
Nå har vi en representasjon av multiline -kommentaren i hovedmetoden i ovennevnte DART -program. Vi har brukt multiline -kommentaren for å gi detaljene om at vi skal lage en heltallliste med listesyntaks i Dart. Deretter har vi konstruert en variabel "liste" som inneholder nummeret på listene med DART -listen representasjon. Igjen har vi brukt multiline kommentarer for å detaljere utskriftsfunksjonen. Listen vil bli skrevet ut på skjermen ved hjelp av utskriftsfunksjonen.
Ved tolkning har vi bare en liste som en utdata. Multiline kommentarteksten vises ikke på skjermen. Det elimineres som standard av kompilatoren.
Eksempel nr. 3: Bruke Doc Single Line -kommentaren i en pil i Ubuntu 20.04
Dokumentasjonskommentarer er en type kommentar som normalt brukes til å produsere dokumentasjon eller en ressurs for en oppgave eller et programvareprodukt. En dokumentasjonskommentar er en enkeltlinje- eller multi-linjekommentar med /// / /* tegn i starten.
Du kan bruke en Doc-kommentar på påfølgende linjer, som er den samme som en multi-line kommentar. Dart -tolken ekskluderer disse linjene bortsett fra de som er lagt inn i de krøllete parentesene. Triple Slash eller Triple Forward Slash kan brukes i en enkeltlinje Doc-kommentar.
Etter å ha opprettet hovedmetoden, har vi brukt tre fremre skråstreker for dokumentasjonen en-linje-kommentar. DOC-kommentaren brukes til erklæringen om variabelen. Dette er egenskapen til DOC en-linjekommentar som brukes før kodens variabler, funksjon eller klassedefinisjon. Variabelen “String1” er deklarert, og initialiserer strengverdien. Deretter har vi seks linjer i dokumentasjonen enkeltlinjekommentar før utskriftsfunksjonen. Vi kan bruke så mange enkeltlinjekommentarer i koden. Men vi må bruke enkeltlinjekommentarene for gyldig informasjon i koden slik at kodeens klarhet ikke blir kompromittert.
Bare utsagnet i utskriftsfunksjonen vises på skjermen. Doc-kommentarene vises på skallet.
Eksempel 4: Bruke Doc Multiline Line -kommentaren i en pil i Ubuntu 20.04
Disse tegnene “**/**…*/**” brukes til å komme med Multi-Line Doc-kommentarer. En Multi-Line Doc-kommentar vises nedenfor. Følgende eksempel forklarer ved hjelp av dokumentasjon multiline kommentarer i dartkoden.
Inne i hovedmetoden brukes DOC Multiline-kommentarer med tilbakeslagskarakteren "/" og dobbelt-Asterisk-karakteren "**.”Vi har bare brukt den fremre skrå karakteren en gang en gang. Dette betyr at vi skrev inn kommentarfeltet og brukte stjerne for å lage doktor ytterligere multiline kommentarer. Deretter endte Doc Multiline-kommentarene med en stjerne karakter og fremover-slash-karakteren "/.”Etter det har vi en uttalelse i utskriftsfunksjonen som bare vises på skjermen.
Doc Multiline kommentarer brukes ikke til utførelsesformål. De blir ignorert av kompilatoren, som vist på skallskjermen.
Konklusjon
Selv om vi anser oss som programmerere, er det meste av teksten i en kildekode designet for menneskelig lesing. Noen sekunder med å skrive en enkel, presis kommentar kan spare en av mange persontimer. Hvert programmeringsspråk støtter kommentarer i den spesifikke koden for leserens bekvemmelighet. Selv om DART -språk har mange måter å lage kommentarer i koden. Vi har en generell representasjon av DART -kommentarene med de fire eksemplene.