Šajā rakstā jūs uzzināsiet par Swift komentāriem, kāpēc un kā tos izmantot.
Komentārs ir programmētāja lasāms paskaidrojums vai anotācija programmas pirmkodā. Kompilators to ignorē, sastādot kodu.
Komentāri ir domāti personai, kas lasa kodu, lai labāk izprastu programmas nolūku un funkcionalitāti. Tas var būt noderīgi, strādājot komandā, lai precizētu koda mērķi citiem komandas locekļiem, vai tikai strādājot, tas var darboties kā atgādinājums par īpašumtiesībām.
Ātrs komentārs un tā veidi
Ātri ir divu veidu komentāri:
1. Vienrindas komentārs
Programmā Swift jebkura rinda, kas sākas ar divām slīpsvītrām, //ir vienas rindiņas komentārs. Viss, kas sākas ar divām slīpsvītrām //, kompilators neņem vērā.
Spēļu laukuma augšpusē varat atrast vienkāršu piemēru:
//: Playground - lietvārds: vieta, kur cilvēki var spēlēt
Tas sākas ar divām slīpsvītrām //un saturiski izskaidro failu kā: "Playground - lietvārds: vieta, kur cilvēki var spēlēt".
1. piemērs: komentārs vienā rindā
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Iepriekš minētajā piemērā ir divi vienas rindas komentāri:
// Paraugprogramma // 3.14 saglabā mainīgajā pi
2. Daudzrindu komentārs
Ja jūsu komentārā ir vairākas rindas, varat to pievienot iekšpusē /*… */.
Daudzrindu komentāri sākas ar slīpsvītru uz priekšu, kam seko zvaigznīte ( /*), un beidzas ar zvaigznīti, kam seko slīpsvītra uz priekšu ( */). Ātrais kompilators ignorē visu starpā esošo /*un */ignorē.
/ * Šis ir daudzrindu komentārs. Pēc daudzrindu komentāra rakstīšanas pievienojiet * sekot /, lai to izbeigtu * /
2. piemērs: daudzrindu komentārs
/* 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)
Iepriekš minētajā piemērā ir daudzrindu komentārs.
/ * Hardcoded pi vērtība var būt mazāk precīza. Lai iegūtu precīzāku vērtību, varat aprēķināt, izmantojot iebūvētos datu tipus * /
Lietas, kas jāatceras
Lai gan komentāri ir nozīmīgi, lai labāk izprastu uzrakstītā kodeksa nolūku. Rakstot to, jums jāņem vērā šādas lietas:
- Nepievienojiet komentārus ar // daudzrindēs, lai gan tas ir derīgs, un kompilators ignorē šīs rindas. Tā vietā pievienojiet to daudzrindu komentārā.
/*… */
Piemērs:// Šis ir komentārs. // Izmantojiet to, kad nepieciešams un precīzi
Iepriekš minētais komentāra rakstīšanas veids ir pareizs, bet nav ieteicams, jo jums ir jāraksta vairāku rindu komentāri, ja komentārs ir lielāks par vienu rindu. Labāks veids, kā rakstīt, ir izmantot daudzrindu komentārus kā:/ * Šis ir komentārs. Izmantojiet to, kad nepieciešams un precīzi * /
- Vienas rindas komentāru var rakstīt atsevišķā rindā vai kopā ar kodu tajā pašā rindā. Tomēr komentārus ieteicams izmantot atsevišķā rindā.
Piemērs:ļaujiet pi = 3,14159 // uzglabā 3,14 mainīgajā pi
Šis komentāru rakstīšanas veids ir derīgs. Bet labāk ir rakstīt komentāru atsevišķā rindā šādi:// 3.14 saglabā mainīgajā pi, ļaujiet pi = 3.14159
- Pat ja komandā esat viens izstrādātājs un jūs vienīgais rakstāt kodu, ja tas nav komentēts, jums būs grūti mēģināt noteikt tā mērķi programmā. Tātad, izmantojiet to precīzi un sniedziet jēgpilnu aprakstu.
- Padariet komentāru ļoti vienkāršu un jēgpilnu.
- Nerakstiet nevajadzīgus komentārus par savu kodu.
- Vairumā gadījumu izmantojiet komentārus, lai paskaidrotu "kāpēc", nevis "kā".
