Hurtige kommentarer: hvordan man bruger dem og hvorfor?

I denne artikel lærer du om Swift-kommentarer, hvorfor og hvordan man bruger dem.

En kommentar er en programmør-læsbar forklaring eller kommentar i kildekoden til et program. Det ignoreres af compileren, når koden kompileres.

Kommentarer er beregnet til personer, der læser koden for bedre at forstå programmets hensigt og funktionalitet. Det kan være nyttigt, når du arbejder på et team for at afklare formålet med koden for andre teammedlemmer, eller mens du udelukkende arbejder, kan det fungere som en påmindelse om at eje.

Hurtig kommentar og dens typer

I hurtig er der to typer kommentarer:

1. Enkelt linjekommentar

I Swift er enhver linje, der starter med to skråstreger //, en enkelt linjekommentar. Alt, der starter med to skråstreger //, ignoreres af compileren.

Du kan finde et simpelt eksempel øverst på legepladsen:

 //: Legeplads - substantiv: et sted, hvor folk kan lege

Det starter med to skråstreger //og giver en meningsfuld forklaring af filen som ": Legeplads - substantiv: et sted, hvor folk kan spille".

Eksempel 1: Enkelt linjekommentar

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

Ovenstående eksempel indeholder to enkeltlinjekommentarer:

 // Eksempelprogram // gemmer 3.14 i variabel pi

2. Multiline-kommentar

Hvis din kommentar indeholder flere linjer, kan du vedlægge den inde /*… */.

Multiline-kommentarer starter med en skråstreg efterfulgt af en stjerne ( /*) og slutter med en stjerne efterfulgt af en skråstreg ( */). Alt imellem /*og */ignoreres af den hurtige kompilator.

/ * Dette er en flerlinjes kommentar. Når du har skrevet flere linjekommenter, tilføj * efterfulgt af / for at afslutte det * /

Eksempel 2: Multiline-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 indeholder en flerlinjekommentar.

/ * Hardkodet pi-værdi er muligvis mindre nøjagtig. Så du kan beregne ved hjælp af indbyggede datatyper for en mere nøjagtig værdi * /

Ting at huske

Selvom kommentarer er meningsfulde for bedre at forstå hensigten med den skrevne kode. Her er ting, du skal overveje, mens du skriver det:

1. Vedlæg ikke kommentarer med // på multiline, selvom det er gyldigt, og compiler ignorerer disse linjer. I stedet vedlæg det i en multiline-kommentar /*… */
   Eksempel:

   // Dette er en kommentar. // Brug det, når det er nødvendigt og præcist

   Ovenstående måde at skrive en kommentar på er korrekt, men anbefales ikke, fordi du er nødt til at skrive kommentarer med flere linjer, hvis kommentaren er større end en linje. Den bedre måde at skrive er at bruge multiline-kommentar som:

   / * Dette er en kommentar. Brug det når det er nødvendigt og præcist * /

2. Enkelts kommentar kan skrives i en separat linje eller sammen med kode i samme linje. Det anbefales dog at bruge kommentarer i en separat linje.
   Eksempel:

    lad pi = 3.14159 // gemmer 3.14 i variabel pi

   Denne måde at skrive kommentarer på er gyldig. Men det er bedre at skrive kommentarer i en separat linje som:

    // gemmer 3.14 i variabel pi lad pi = 3.14159 

3. Selvom du er en enkelt udvikler i et team, og du er den eneste, der skriver koden, hvis den ikke er kommenteret, har du svært ved at forsøge at finde sit formål i programmet. Så brug det nøjagtigt og giv en meningsfuld beskrivelse.
4. Gør kommentar meget enkel og meningsfuld.
5. Skriv ikke unødvendige kommentarer til din kode.
6. I de fleste tilfælde skal du bruge kommentarer til at forklare 'hvorfor' i stedet for 'hvordan'.