Greiti komentarai: kaip juos naudoti ir kodėl?

Šiame straipsnyje sužinosite apie „Swift“ komentarus, kodėl ir kaip juos naudoti.

Komentaras yra programuotojo skaitomas programos šaltinio kodo paaiškinimas arba komentaras. Sudarant kodą kompiliatorius jo nepaiso.

Komentarai skirti asmeniui, skaitančiam kodą, kad geriau suprastų programos tikslą ir funkcionalumą. Tai gali būti naudinga dirbant komandoje, norint patikslinti kodo paskirtį kitiems komandos nariams, arba dirbant vien tik tai gali būti priminimas turėti.

Greitas komentaras ir jo tipai

Greitai yra dviejų tipų komentarai:

1. Vienos eilutės komentaras

„Swift“ bet kuri eilutė, prasidedanti dviem pasviraisiais brūkšneliais, //yra vienos eilutės komentaras //. Kompiliatorius ignoruoja viską, kas prasideda dviem brūkšneliais .

Žaidimų aikštelės viršuje galite rasti paprastą pavyzdį:

 //: Žaidimų aikštelė - daiktavardis: vieta, kur žmonės gali žaisti

Jis prasideda dviem pasvirais brūkšneliais //ir pateikia reikšmingą bylos paaiškinimą: „Žaidimų aikštelė - daiktavardis: vieta, kur žmonės gali žaisti“.

1 pavyzdys: vienos eilutės komentaras

 //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi) 

Ankstesniame pavyzdyje yra du vienos eilutės komentarai:

 // Pavyzdinė programa // saugo 3.14 kintamajame pi

2. Daugiasluoksnis komentaras

Jei jūsų komentaras apima kelias eilutes, galite jį pridėti viduje /*… */.

Kelių eilių komentarai prasideda pasviruoju brūkšniu, po kurio yra žvaigždutė ( /*), ir baigiasi žvaigždute, po kurios eina brūkšnys į priekį ( */). Greitas kompiliatorius ignoruoja viską, kas yra tarp jų, /*ir */ignoruoja.

/ * Tai daugiasluoksnis komentaras. Parašę daugiasluoksnį komentarą pridėkite * sekdami /, kad jį užbaigtumėte * /

2 pavyzdys: kelių eilučių komentaras

 /* 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) 

Aukščiau pateiktame pavyzdyje yra kelių eilučių komentaras.

/ * Hardcoded pi vertė gali būti ne tokia tiksli. Taigi galite apskaičiuoti naudodami pastatytus duomenų tipus, kad gautumėte tikslesnę vertę * /

Dalykai, kuriuos reikia atsiminti

Nors komentarai yra prasmingi, norint geriau suprasti parašyto kodekso tikslą. Štai ką reikia apsvarstyti jį rašant:

1. Nepridėkite komentarų su // daugybėje eilutėje, nors tai galioja, o kompiliatorius nepaiso tų eilučių. Vietoj to įdėkite jį į daugiasluoksnį komentarą. /*… */
   Pavyzdys:

   // Tai komentaras. // Naudokite, kai reikia ir tiksliai

   Aukščiau pateiktas komentaro rašymo būdas yra teisingas, bet nerekomenduojamas, nes jums reikia parašyti kelių eilučių komentarus, jei komentaras yra didesnis nei viena eilutė. Geresnis būdas rašyti yra naudoti kelių eilučių komentarą:

   / * Tai komentaras. Naudokite, kai reikia ir tiksliai * /

2. Vienos eilutės komentaras gali būti parašytas atskiroje eilutėje arba kartu su kodu toje pačioje eilutėje. Tačiau rekomenduojama komentarus naudoti atskiroje eilutėje.
   Pavyzdys:

    tegul pi = 3,14159 // 3,14 saugo kintamajame pi

   Šis komentarų rašymo būdas galioja. Bet geriau komentarą parašyti atskiroje eilutėje kaip:

    // saugo 3.14 kintamajame pi, leiskite pi = 3.14159 

3. Net jei esate vienas kūrėjas komandoje ir jūs vienintelis rašote kodą, jei jis nekomentuojamas, jums bus sunku bandyti suprasti jo tikslą programoje. Taigi, naudokite jį tiksliai ir pateikite prasmingą aprašymą.
4. Padarykite komentarą labai paprastą ir prasmingą.
5. Nerašykite nereikalingų komentarų apie savo kodą.
6. Daugeliu atvejų naudokite komentarus, kad paaiškintumėte „kodėl“, o ne „kaip“.