U ovom ćete članku naučiti o Swift komentarima, zašto i kako ih koristiti.
Komentar je programeru čitljivo objašnjenje ili napomena u izvornom kodu programa. Kompajler ga ignorira kada se kod kompajlira.
Komentari su namijenjeni osobi koja čita kôd kako bi bolje razumjela namjeru i funkcionalnost programa. Može biti korisno dok radite u timu kako biste razjasnili svrhu koda za druge članove tima ili dok radite isključivo može djelovati kao podsjetnik na svoje.
Brzi komentar i njegove vrste
Ubrzo postoje dvije vrste komentara:
1. Jednoredni komentar
U Swiftu je svaki redak koji započinje s dvije kose //crte komentar u jednom retku. Kompilator //ignorira sve što počinje s dvije kose crte .
Jednostavan primjer možete pronaći na vrhu igrališta:
//: Igralište - imenica: mjesto gdje se ljudi mogu igrati
Počinje s dvije kose crte //i pruža smisleno objašnjenje datoteke kao ": Igralište - imenica: mjesto na kojem se ljudi mogu igrati".
Primjer 1: Jednoredni komentar
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Gornji primjer sadrži dva retka komentara:
// Uzorak programa // pohranjuje 3,14 u varijablu pi
2. Višeredni komentar
Ako vaš komentar sadrži više redaka, možete ga priložiti unutra /*… */.
Višeredni komentari započinju kosom crtom nakon koje slijedi zvjezdica ( /*), a završavaju zvjezdicom slijedenom kosom crtom ( */). Sve između /*i */brzi kompajler ignorira.
/ * Ovo je višeredni komentar. Nakon što napišete višeredni komentar, dodajte * slijedeći do / da biste ga završili * /
Primjer 2: Višeredni 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)
Gornji primjer sadrži višeredni komentar.
/ * Tvrdo kodirana vrijednost pi može biti manje točna. Tako možete izračunati pomoću ugrađenih vrsta podataka za precizniju vrijednost * /
Stvari za pamćenje
Iako su komentari značajni za bolje razumijevanje namjere napisanog koda. Evo nekoliko stvari koje morate uzeti u obzir prilikom pisanja:
- Ne prilažite komentare s // na višeredu iako je valjan, a kompajler ih ignorira. Umjesto toga, zatvorite ga u višeredni komentar
/*… */
Primjer:// Ovo je komentar. // Koristite ga kad je potrebno i precizno
Gornji način za pisanje komentara je točan, ali se ne preporučuje, jer morate napisati višeredne komentare ako je komentar veći od jednog retka. Bolji način pisanja je korištenje višerednih komentara kao:/ * Ovo je komentar. Koristite ga kad je potrebno i precizno * /
- Komentar u jednom retku može se napisati u zasebni redak ili zajedno s kodom u istom retku. No, preporuča se korištenje komentara u zasebnom retku.
Primjer:neka je pi = 3,14159 // pohranjuje 3,14 u varijablu pi
Ovaj način pisanja komentara vrijedi. Ali bolje je komentar napisati u zasebnom retku kao:// pohranjuje 3,14 u varijablu pi let pi = 3,14159
- Čak i ako ste jedan programer u timu, a vi jedini pišete kôd, ako je nekomentiran, teško ćete pokušati shvatiti njegovu svrhu u programu. Dakle, koristite ga precizno i pružite smislen opis.
- Neka komentar bude vrlo jednostavan i smislen.
- Ne pišite nepotrebne komentare na svoj kod.
- U većini slučajeva upotrijebite komentare da biste objasnili "zašto", a ne "kako".
