V tomto článku sa dozviete o komentároch Swift, prečo a ako ich používať.
Komentár je programátorsky čitateľné vysvetlenie alebo anotácia v zdrojovom kóde programu. Pri kompilácii kódu to kompilátor ignoruje.
Komentáre sú určené pre osobu, ktorá číta kód, aby lepšie pochopila zámer a funkčnosť programu. Môže byť užitočné pri práci na tíme objasniť účel kódu pre ostatných členov tímu alebo pri práci výlučne môže slúžiť ako pripomienka k vlastníctvu.
Rýchly komentár a jeho typy
Rýchlo existujú dva typy komentárov:
1. Jednoriadkový komentár
V Swifte je každý riadok začínajúci dvoma lomkami //komentárom jedného riadku. Všetko, čo začína dvoma lomítkami, //kompilátor ignoruje.
Jednoduchý príklad nájdete v hornej časti ihriska:
//: Ihrisko - podstatné meno: miesto, kde si môžu ľudia zahrať
Začína sa dvoma lomkami //a poskytuje zmysluplné vysvetlenie súboru ako „: Detské ihrisko - podstatné meno: miesto, kde si ľudia môžu zahrať“.
Príklad 1: Jednoriadkový komentár
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Vyššie uvedený príklad obsahuje dva jednoriadkové komentáre:
// Ukážkový program // uloží 3,14 do premennej pi
2. Viacriadkový komentár
Ak váš komentár obsahuje viac riadkov, môžete ho vložiť dovnútra /*… */.
Viacriadkové komentáre sa začínajú lomkou, za ktorou nasleduje hviezdička ( /*), a končia sa hviezdičkou, za ktorou nasleduje lomka ( */). Všetko medzi tým /*a */ignoruje rýchlym kompilátorom.
/ * Toto je viacriadkový komentár. Po napísaní viacriadkového komentára pridajte * za / na ukončenie * /
Príklad 2: Viacriadkový komentár
/* 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)
Vyššie uvedený príklad obsahuje viacriadkový komentár.
/ * Pevne zakódovaná hodnota pí môže byť menej presná. Takže môžete vypočítať použitie zabudovaných typov údajov pre presnejšiu hodnotu * /
Na čo treba pamätať
Aj keď komentáre majú zmysel pre lepšie pochopenie zámeru napísaného kódu. Pri písaní je potrebné vziať do úvahy nasledujúce skutočnosti:
- Nezahŕňajte komentáre do // na viacriadkovej linke, aj keď je to platné a kompilátor tieto riadky ignoruje. Namiesto toho ho vložte do viacriadkového komentára
/*… */
Príklad:// Toto je komentár. // Použite ho, keď je to potrebné a presne
Vyššie uvedený spôsob písania komentára je správny, ale neodporúča sa, pretože ak je komentár väčší ako jeden riadok, musíte napísať viacriadkové komentáre. Lepší spôsob písania je použitie viacriadkového komentára ako:/ * Toto je komentár. Použite ho, keď je to potrebné a presne * /
- Komentár k jednému riadku je možné napísať do samostatného riadku alebo spolu s kódom do rovnakého riadku. Odporúča sa však použiť komentáre v samostatnom riadku.
Príklad:nech pi = 3.14159 // uloží 3,14 do premennej pi
Tento spôsob písania komentárov je platný. Je však lepšie napísať komentár do samostatného riadku ako:// uloží 3,14 do premennej pi let pi = 3,14159
- Aj keď ste jediný vývojár v tíme a ste jediný, kto kód píše, ak je nekomentovaný, budete sa ťažko usilovať zistiť jeho účel v programe. Používajte ho teda presne a uveďte zmysluplný popis.
- Vytvorte komentár veľmi jednoduchým a zmysluplným.
- K svojmu kódu nepíšte zbytočné komentáre.
- Vo väčšine prípadov pomocou komentárov vysvetlite „prečo“ a nie „ako“.
