I den här artikeln lär du dig om Swift-kommentarer, varför och hur du använder dem.
En kommentar är en programmerbar läsbar förklaring eller anteckning i källkoden för ett program. Det ignoreras av kompilatorn när koden kompileras.
Kommentarer är avsedda för personer som läser koden för att bättre förstå programmets avsikt och funktionalitet. Det kan vara till hjälp när du arbetar i ett team för att klargöra syftet med koden för andra lagmedlemmar eller när du bara arbetar kan det fungera som en påminnelse om att äga.
Snabb kommentar och dess typer
Snabbt finns det två typer av kommentarer:
1. Enkelradskommentar
I Swift är varje rad som börjar med två snedstreck //en enda radkommentar. Allt som börjar med två snedstreck //ignoreras av kompilatorn.
Du hittar ett enkelt exempel högst upp på lekplatsen:
//: Lekplats - substantiv: en plats där människor kan spela
Det börjar med två snedstreck //och ger en meningsfull förklaring av filen som ": Lekplats - substantiv: en plats där människor kan spela".
Exempel 1: Enkelradskommentar
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Ovanstående exempel innehåller två enstaka kommentarer:
// Provprogram // lagrar 3.14 i variabel pi
2. Flerlinjekommentar
Om din kommentar innehåller flera rader kan du bifoga den inuti /*… */.
Flerlinjekommentarer börjar med en snedstreck framåt följt av en asterisk ( /*) och slutar med en asterisk följt av en snedstreck ( */). Allt däremellan /*och */ignoreras av den snabba kompilatorn.
/ * Detta är en flerlinjeskommentar. När du har skrivit flerlinjeskommentar lägg till * följ av / för att avsluta det * /
Exempel 2: Multilinjekommentar
/* 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)
Ovanstående exempel innehåller en kommentar med flera rader.
/ * Hardkodat pi-värde kan vara mindre exakt. Så du kan beräkna med hjälp av inbyggda datatyper för mer exakt värde * /
Saker att komma ihåg
Även om kommentarer är meningsfulla för att bättre förstå avsikten med den skrivna koden. Här är saker du måste tänka på när du skriver det:
- Bifoga inte kommentarer med // på multilinje även om det är giltigt och kompilatorn ignorerar dessa rader. Bifoga det i stället i flerlinjeskommentar
/*… */
Exempel:// Detta är en kommentar. // Använd den vid behov och exakt
Ovanstående sätt att skriva kommentarer är korrekt men rekommenderas inte eftersom du behöver skriva flerlinjeskommentarer om kommentaren är större än en rad. Det bättre sättet att skriva är att använda flerlinjekommentarer som:/ * Detta är en kommentar. Använd den vid behov och exakt * /
- Enkelradkommentar kan skrivas i en separat rad eller tillsammans med kod i samma rad. Det rekommenderas dock att använda kommentarer i en separat rad.
Exempel:låt pi = 3.14159 // lagrar 3.14 i variabel pi
Detta sätt att skriva kommentarer är giltigt. Men det är bättre att skriva kommentarer i en separat rad som:// lagrar 3.14 i variabel pi let pi = 3.14159
- Även om du är en enda utvecklare i ett team, och du är den enda som skriver koden, om den inte är kommenterad, kommer du att ha svårt att försöka räkna ut dess syfte i programmet. Så använd det exakt och ge en meningsfull beskrivning.
- Gör kommentarer mycket enkla och meningsfulla.
- Skriv inte onödiga kommentarer till din kod.
- I de flesta fall använder du kommentarer för att förklara "varför" snarare än "hur".
