Raske kommentarer: Hvordan bruker jeg dem og hvorfor?

I denne artikkelen vil du lære om Swift-kommentarer, hvorfor og hvordan du bruker dem.

En kommentar er en programmerbar lesbar forklaring eller merknad i kildekoden til et program. Det ignoreres av kompilatoren når koden kompileres.

Kommentarer er ment for personer som leser koden for å bedre forstå intensjonen og funksjonaliteten til programmet. Det kan være nyttig når du jobber med et team for å avklare formålet med koden for andre teammedlemmer, eller mens du arbeider utelukkende, kan det fungere som en påminnelse om å eie.

Rask kommentar og dens typer

Det er raskt to typer kommentarer:

1. Enkeltlinjekommentar

I Swift er enhver linje som begynner med to skråstreker //en enkelt linjekommentar. Alt som begynner med to skråstreker //ignoreres av kompilatoren.

Du finner et enkelt eksempel øverst på lekeplassen:

 //: Lekeplass - substantiv: et sted hvor folk kan leke

Det starter med to skråstreker //og gir en meningsfull forklaring på filen som ": Lekeplass - substantiv: et sted hvor folk kan spille".

Eksempel 1: Enkel linje kommentar

 //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)

Ovennevnte eksempel inneholder to enkeltlinjekommentarer:

 // Eksempelprogram // lagrer 3.14 i variabel pi

2. Multiline-kommentar

Hvis kommentaren inneholder flere linjer, kan du legge den inn /*… */.

Kommentarer fra flere linjer starter med en skråstrek etterfulgt av en stjerne ( /*) og slutter med en stjerne etterfulgt av en skråstrek ( */). Alt i mellom /*og */blir ignorert av den raske kompilatoren.

/ * Dette er en flerlinjekommentar. Etter at du har skrevet flere linjekommenter, legg til * følger av / for å avslutte det * /

Eksempel 2: Multilinje-kommentar

 /* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)

Ovenstående eksempel inneholder en flerlinjekommentar.

/ * Hardkodet pi-verdi kan være mindre nøyaktig. Så du kan beregne med innebygde datatyper for mer nøyaktig verdi * /

Ting å huske

Selv om kommentarer er meningsfylte for bedre å forstå intensjonen med den skrevne koden. Her er ting du må vurdere når du skriver det:

Ikke legg inn kommentarer med // på flerlinje, selv om det er gyldig og kompilatoren ignorerer disse linjene. I stedet legge den inn i flere linjekommentarer /*… */
Eksempel:
```
// Dette er en kommentar. // Bruk den når det er nødvendig og presist
```
Ovennevnte måte å skrive en kommentar på er korrekt, men anbefales ikke fordi du trenger å skrive flerlinjekommentarer hvis kommentaren er større enn en linje. Den bedre måten å skrive er å bruke flerlinjekommentarer som:
```
/ * Dette er en kommentar. Bruk den når det er nødvendig og presist * /
```
Enkelts kommentar kan skrives i en egen linje eller sammen med kode i samme linje. Det anbefales imidlertid å bruke kommentarer i en egen linje.
Eksempel:
```
 la pi = 3.14159 // lagrer 3.14 i variabel pi
```
Denne måten å skrive kommentarer på er gyldig. Men det er bedre å skrive kommentarer i en egen linje som:
```
 // lagrer 3.14 i variabel pi la pi = 3.14159 
```
Selv om du er en enkelt utvikler i et team, og du er den eneste som skriver koden, hvis den ikke er kommentert, vil du ha vanskelig for å prøve å finne formålet med programmet. Så bruk den presist og gi en meningsfull beskrivelse.
Gjør kommentarer veldig enkle og meningsfulle.
Ikke skriv unødvendige kommentarer til koden din.
I de fleste tilfeller kan du bruke kommentarer til å forklare 'hvorfor' i stedet for 'hvordan'.