Tässä artikkelissa opit Swift-kommenteista, miksi ja miten niitä käytetään.
Kommentti on ohjelmoijan lukema selitys tai merkintä ohjelman lähdekoodissa. Kääntäjä jättää sen huomiotta koodia käännettäessä.
Kommentit on tarkoitettu koodia lukevalle henkilölle ymmärtämään paremmin ohjelman tarkoitusta ja toimivuutta. Se voi olla hyödyllistä työskennellessäsi ryhmässä selventää koodin tarkoitus ryhmän muille jäsenille tai työskennellessään yksinomaan se voi toimia muistutuksena omistamisesta.
Nopea kommentti ja sen tyypit
Nopeasti on olemassa kahdenlaisia kommentteja:
1. Yhden rivin kommentti
Swiftissä mikä tahansa kahdella kauttaviivalla alkava rivi //on yhden rivin kommentti, //kääntäjä jättää huomiotta kaikki, jotka alkavat kahdella vinoviivalla .
Löydät yksinkertaisen esimerkin leikkikentän yläosasta:
//: Leikkikenttä - substantiivi: paikka, jossa ihmiset voivat pelata
Se alkaa kahdella kauttaviivalla //ja selittää tiedoston mielekkäästi seuraavasti: "Leikkikenttä - substantiivi: paikka, jossa ihmiset voivat pelata".
Esimerkki 1: Yksirivinen kommentti
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Yllä oleva esimerkki sisältää kaksi yhden rivin kommenttia:
// Näyteohjelma // tallentaa 3.14 muuttujaan pi
2. Monirivinen kommentti
Jos kommenttisi sisältää useita rivejä, voit liittää ne sisälle /*… */.
Moniriviset kommentit alkavat vinoviivalla, jota seuraa tähti ( /*) ja päättyvät tähdellä, jota seuraa eteenpäin-vinoviiva ( */). Nopea kääntäjä jättää kaiken väliin /*ja */jättää huomiotta.
/ * Tämä on monirivinen kommentti. Kun olet kirjoittanut monirivisen kommentin, lisää * seuraamalla / lopettaaksesi sen * /
Esimerkki 2: Monirivinen kommentti
/* 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)
Yllä oleva esimerkki sisältää monirivisen kommentin.
/ * Kovakoodattu pi-arvo voi olla vähemmän tarkka. Joten voit laskea käyttämällä sisäänrakennettuja tietotyyppejä saadaksesi tarkemman arvon * /
Muistettavaa
Vaikka kommentit ovat mielekkäitä, jotta ymmärretään paremmin kirjoitetun koodin tarkoitus. Tässä on asioita, jotka sinun on otettava huomioon kirjoittaessasi:
- Älä liitä kommentteja // moniriviseen, vaikka se on kelvollinen ja kääntäjä ohittaa nämä rivit. Sen sijaan liitä se monirivisen kommentin sisään
/*… */
Esimerkki:// Tämä on kommentti. // Käytä sitä tarvittaessa ja tarkasti
Yllä oleva tapa kirjoittaa kommentti on oikea, mutta sitä ei suositella, koska sinun on kirjoitettava monirivisiä kommentteja, jos kommentti on suurempi kuin yksi rivi. Parempi tapa kirjoittaa on käyttää monirivisiä kommentteja seuraavasti:/ * Tämä on kommentti. Käytä sitä tarvittaessa ja tarkasti * /
- Yksirivinen kommentti voidaan kirjoittaa erilliselle riville tai samalla rivillä olevan koodin kanssa. On kuitenkin suositeltavaa käyttää kommentteja erillisellä rivillä.
Esimerkki:olkoon pi = 3.14159 // tallentaa 3.14 muuttujaan pi
Tämä tapa kirjoittaa kommentteja on kelvollinen. Mutta on parempi kirjoittaa kommentti erilliselle riville:// tallentaa 3.14 muuttujaan pi, olkoon pi = 3.14159
- Vaikka olisit yksi kehittäjä tiimissä ja olet ainoa, joka kirjoittaa koodia, jos sitä ei kommentoida, sinulla on vaikeuksia yrittää selvittää sen tarkoitus ohjelmassa. Joten käytä sitä tarkasti ja anna mielekäs kuvaus.
- Tee kommentista hyvin yksinkertainen ja mielekäs.
- Älä kirjoita tarpeettomia kommentteja koodiin.
- Useimmissa tapauksissa käytä kommentteja selittääkseen miksi eikä "miten".
