V tem članku boste izvedeli več o komentarjih Swift, zakaj in kako jih uporabljati.
Komentar je programerju berljiva razlaga ali pripis v izvorni kodi programa. Prevajalnik ga pri prevajanju kode prezre.
Komentarji so namenjeni osebi, ki bere kodo, da bi bolje razumela namen in funkcionalnost programa. Pri delu v skupini je lahko koristno, če želite razjasniti namen kode za druge člane ekipe, ali pa lahko samo pri delu deluje kot opomnik, da ga imate.
Hitri komentar in njegove vrste
Na hitro obstajajo dve vrsti komentarjev:
1. Enovrstni komentar
V Swiftu je vsaka vrstica, ki se začne z dvema poševnima //črtama, komentar z eno vrstico //. Prevajalnik prezre vse, kar se začne z dvema poševnima črtama.
Na vrhu igrišča najdete preprost primer:
//: Igrišče - samostalnik: kraj, kjer se lahko ljudje igrajo
Začne se z dvema poševnima črtama //in daje smiselno razlago datoteke kot ": Igrišče - samostalnik: kraj, kjer se lahko ljudje igrajo".
Primer 1: Enovrstni komentar
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Zgornji primer vsebuje dve enovrstni komentar:
// Vzorčni program // shrani 3.14 v spremenljivko pi
2. Komentar več vrstic
Če vaš komentar vključuje več vrstic, ga lahko priložite v notranjost /*… */.
Komentarji z več vrsticami se začnejo s poševnico naprej, ki ji sledi zvezdica ( /*) in končajo z zvezdico, ki ji sledi poševnica naprej ( */). Vse vmesno /*in */ga hitri prevajalnik prezre.
/ * To je večvrstični komentar. Ko napišete večvrstični komentar, dodajte *, ki ga sledi /, da ga končate * /
2. primer: večvrstni komentar
/* 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)
Zgornji primer vsebuje večvrstični komentar.
/ * Vrednost trdo kodirane pi je morda manj natančna. Tako lahko za natančnejšo vrednost izračunate z uporabo vgrajenih podatkovnih tipov * /
Stvari, ki si jih je treba zapomniti
Čeprav so komentarji smiselni za boljše razumevanje namena napisane kode. Tu je nekaj, kar morate upoštevati med pisanjem:
- Komentarjev ne prilagajte z // na več vrstic, čeprav je veljaven in jih prevajalnik prezre. Namesto tega ga zaprite v večvrstni komentar
/*… */
Primer:// To je komentar. // Uporabite ga po potrebi in natančno
Zgornji način za pisanje komentarja je pravilen, vendar ni priporočljiv, ker morate napisati večvrstične komentarje, če je komentar daljši od ene vrstice. Boljši način za pisanje je uporaba večvrstičnega komentarja kot:/ * To je komentar. Uporabite ga po potrebi in natančno * /
- Enovrstni komentar lahko napišete v ločeni vrstici ali skupaj s kodo v isti vrstici. Priporočljivo pa je, da komentarje uporabite v ločeni vrstici.
Primer:naj pi = 3,14159 // shrani 3,14 v spremenljivko pi
Ta način pisanja komentarjev je veljaven. Vendar je bolje, da komentar napišete v ločeni vrstici kot:// shrani 3,14 v spremenljivko pi let pi = 3,14159
- Tudi če ste en razvijalec v skupini in ste edini, ki pišete kodo, če je nekomentirana, boste težko skušali ugotoviti njen namen v programu. Torej, natančno ga uporabite in zagotovite pomemben opis.
- Komentar naj bo zelo preprost in smiseln.
- Na svojo kodo ne pišite nepotrebnih komentarjev.
- V večini primerov s komentarji razložite "zakaj" in ne "kako".
