У цій статті ви дізнаєтесь про коментарі Swift, чому та як ними користуватися.
Коментар - це зрозуміле програмістом пояснення або анотація у вихідному коді програми. Компілятор ігнорує його при компіляції коду.
Коментарі призначені для того, хто читає код, щоб краще зрозуміти наміри та функціональність програми. Це може бути корисно під час роботи в команді, щоб пояснити призначення коду для інших членів команди, або, працюючи виключно, це може бути нагадуванням про володіння.
Швидкий коментар та його типи
У "Свіфт" є два типи коментарів:
1. Однорядковий коментар
У Swift будь-який рядок, що починається з двох скісних рисок, //є однорядковим коментарем //.
Ви можете знайти простий приклад у верхній частині дитячого майданчика:
//: Дитячий майданчик - іменник: місце, де люди можуть грати
Він починається з двох скісних рисок //і надає значуще пояснення файлу як ": 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
- Навіть якщо ви єдиний розробник у команді, і ви єдиний, хто пише код, якщо він не прокоментований, вам буде важко спробувати зрозуміти його мету в програмі. Тож використовуйте його точно і надайте змістовний опис.
- Зробіть коментар дуже простим та змістовним.
- Не пишіть зайвих коментарів до свого коду.
- У більшості випадків використовуйте коментарі, щоб пояснити "чому", а не "як".
