В тази статия ще научите за коментарите на Swift, защо и как да ги използвате.
Коментарът е четено от програмиста обяснение или анотация в изходния код на програма. Той се игнорира от компилатора, когато кодът се компилира.
Коментарите са предназначени за човек, който чете кода, за да разбере по-добре намерението и функционалността на програмата. Може да бъде полезно, докато работите в екип, за да изясните целта на кода за други членове на екипа или докато работите само той може да действа като напомняне за притежание.
Бърз коментар и неговите типове
В swift има два вида коментари:
1. Едноредов коментар
В Swift всеки ред, започващ с две наклонени черти, //е едноредов коментар. Всичко, което започва с две наклонени черти, //се игнорира от компилатора.
Можете да намерите прост пример в горната част на детската площадка:
//: Playground - съществително: място, където хората могат да играят
Започва с две наклонени черти //и предоставя смислено обяснение на файла като ": Playground - съществително: място, където хората могат да играят".
Пример 1: Едноредов коментар
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Горният пример съдържа коментар от два реда:
// Примерна програма // съхранява 3.14 в променлива pi
2. Многоредов коментар
Ако вашият коментар включва няколко реда, можете да го приложите вътре /*… */.
Многоредови коментари започват с наклонена черта напред, последвана от звездичка ( /*) и завършват със звездичка, последвана от наклонена черта ( */). Всичко между тях /*и */се игнорира от компилатора бърза.
/ * Това е многоредов коментар. След като напишете многоредов коментар, добавете * след от / за да го прекратите * /
Пример 2: Многоредов коментар
/* 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)
Горният пример съдържа многоредов коментар.
/ * Твърдо кодираната стойност pi може да е по-малко точна. Така че можете да изчислите, като използвате вградени типове данни за по-точна стойност * /
Неща за запомняне
Въпреки че коментарите са значими, за да се разбере по-добре намерението на написания код. Ето неща, които трябва да имате предвид, докато го пишете:
- Не ограждайте коментари с // на многоредова линия, въпреки че е валидна и компилаторът игнорира тези редове. Вместо това го затворете в многоредов коментар
/*… */
Пример:// Това е коментар. // Използвайте го, когато е необходимо и точно
Горният начин за писане на коментар е правилен, но не се препоръчва, защото трябва да пишете многоредови коментари, ако коментарът е по-голям от един ред. По-добрият начин за писане е използването на многоредов коментар като:/ * Това е коментар. Използвайте го, когато е необходимо и точно * /
- Едноредов коментар може да бъде написан в отделен ред или заедно с код в същия ред. Препоръчително е обаче да използвате коментари в отделен ред.
Пример:нека pi = 3.14159 // съхранява 3.14 в променлива pi
Този начин за писане на коментари е валиден. Но е по-добре да напишете коментар в отделен ред като:// съхранява 3.14 в променлива pi let pi = 3.14159
- Дори ако сте един разработчик в екип и вие сте единственият, който пише кода, ако той е некомментиран, трудно ще се опитате да разберете целта му в програмата. Така че, използвайте го прецизно и предоставете смислено описание.
- Направете коментара много прост и смислен.
- Не пишете ненужни коментари на вашия код.
- В повечето случаи използвайте коментари, за да обясните „защо“, а не „как“.
