Selles artiklis saate teada Swifti kommentaaride kohta, miks ja kuidas neid kasutada.
Kommentaar on programmeerija poolt loetav selgitus või märkused programmi lähtekoodis. Kood kompileerimisel ignoreerib kompilaator seda.
Kommentaarid on mõeldud koodi lugevale isikule, et paremini mõista programmi eesmärki ja funktsionaalsust. See võib olla abiks meeskonnas töötades, et selgitada koodi eesmärki teistele meeskonnaliikmetele, või ainult töötades võib see meeldetuletus omada.
Kiire kommentaar ja selle tüübid
Kiiresti on kahte tüüpi kommentaare:
1. Ühe rea kommentaar
Swiftis //on iga kahe kaldkriipsuga algav rida ühe rea kommentaar //. Koostaja ignoreerib kõike, mis algab kahe kaldkriipsuga .
Mänguväljaku ülaosast leiate lihtsa näite:
//: Mänguväljak - nimisõna: koht, kus inimesed saavad mängida
See algab kahe kaldkriipsuga //ja annab failile sisuka selgituse järgmiselt: "Mänguväljak - nimisõna: koht, kus inimesed saavad mängida".
Näide 1: Ühe rea kommentaar
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Ülaltoodud näide sisaldab kahte ühe rea kommentaari:
// Näidisprogramm // salvestab 3.14 muutujasse pi
2. Mitmerealine kommentaar
Kui teie kommentaar sisaldab mitut rida, saate selle lisada /*… */.
Mitmerealised kommentaarid algavad kaldkriipsuga, millele järgneb tärn ( /*), ja lõpevad tärniga, millele järgneb kaldkriips ( */). Kõik vahepealne /*ja */kiire kompilaator ignoreerib seda.
/ * See on mitmerealine kommentaar. Pärast mitmerealise kommentaari kirjutamist lisage selle lõpetamiseks * järgmine /
Näide 2: Mitmerealine kommentaar
/* 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)
Ülaltoodud näide sisaldab mitmerealist kommentaari.
/ * Kõvakodeeritud pi väärtus võib olla vähem täpne. Nii saate täpsema väärtuse saamiseks arvutada sisseehitatud andmetüüpide abil * /
Asjad, mida meeles pidada
Kuigi kommentaarid on sisukad, et paremini mõista kirjutatud koodi kavatsust. Selle kirjutamisel peate arvestama järgmiste asjadega:
- Ärge lisage mitmerealistele kommentaare //-ga, kuigi see on kehtiv ja kompilaator eirab neid ridu. Selle asemel lisage see mitmerealise kommentaari sisse
/*… */
Näide:// See on kommentaar. // Kasutage seda vajadusel ja täpselt
Ülaltoodud kommentaari kirjutamise viis on õige, kuid pole soovitatav, kuna peate kirjutama mitmerealised kommentaarid, kui kommentaar on suurem kui üks rida. Parem viis kirjutamiseks on mitmerealise kommentaari kasutamine järgmiselt:/ * See on kommentaar. Kasutage seda vajadusel ja täpselt * /
- Ühe rea kommentaari saab kirjutada eraldi real või koos koodiga samal real. Siiski on soovitatav kasutada kommentaare eraldi real.
Näide:olgu pi = 3.14159 // salvestab 3.14 muutujas pi
See kommentaaride kirjutamise viis on kehtiv. Kuid parem on kirjutada kommentaar eraldi rida järgmiselt:// salvestab muutuja pi 3,14, olgu pi = 3,14159
- Isegi kui olete meeskonnas üks arendaja ja kirjutate koodi ainult teie, on teil selle märkimata jätmise korral raske proovida selle eesmärki programmis välja mõelda. Niisiis, kasutage seda täpselt ja andke sisukas kirjeldus.
- Muutke kommentaar väga lihtsaks ja sisukaks.
- Ärge kirjutage oma koodile tarbetuid kommentaare.
- Enamasti kasutage kommentaaride abil pigem miks, mitte kuidas?
