Swift Komentáře: Jak je používat a proč?

V tomto článku se dozvíte o komentářích Swift, proč a jak je používat.

Komentář je programátorsky čitelné vysvětlení nebo poznámka ve zdrojovém kódu programu. Při kompilaci kódu je kompilátorem ignorován.

Komentáře jsou určeny pro osobu, která čte kód, aby lépe porozuměla záměru a funkčnosti programu. Může být užitečné při práci v týmu objasnit účel kódu pro ostatní členy týmu nebo při samotné práci může sloužit jako připomenutí vlastnit.

Rychlý komentář a jeho typy

Rychle existují dva typy komentářů:

1. Jednořádkový komentář

Ve Swiftu je každý řádek začínající dvěma lomítky //komentářem v jednom řádku. Vše, co začíná dvěma lomítky, //kompilátor ignoruje.

Jednoduchý příklad najdete v horní části hřiště:

 //: Hřiště - podstatné jméno: místo, kde si lidé mohou hrát

Začíná se dvěma lomítky //a poskytuje smysluplné vysvětlení souboru jako „: Hřiště - podstatné jméno: místo, kde si lidé mohou hrát“.

Příklad 1: Jednořádkový komentář

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

Výše uvedený příklad obsahuje dva jednořádkové komentáře:

 // Ukázkový program // uloží 3,14 do proměnné pi

2. Víceřádkový komentář

Pokud váš komentář obsahuje více řádků, můžete jej uvést dovnitř /*… */.

Víceřádkové komentáře začínají lomítkem následovaným hvězdičkou ( /*) a končí hvězdičkou následovanou lomítkem ( */). Všechno mezi tím /*a */ignoruje rychlým kompilátorem.

/ * Toto je víceřádkový komentář. Poté, co napíšete víceřádkový komentář, přidejte * za / k ukončení * /

Příklad 2: Víceřádkový komentář

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

Výše uvedený příklad obsahuje víceřádkový komentář.

/ * Pevně ​​zakódovaná hodnota pí může být méně přesná. Takže můžete vypočítat použití vestavěných datových typů pro přesnější hodnotu * /

Věci k zapamatování

Ačkoli komentáře mají smysl pro lepší pochopení záměru napsaného kódu. Při psaní je třeba vzít v úvahu následující:

1. Nezadávejte komentáře s // na víceřádkovém, i když je to platné a kompilátor tyto řádky ignoruje. Místo toho jej uzavřete do víceřádkového komentáře /*… */
   Příklad:

   // Toto je komentář. // Použijte jej v případě potřeby a přesně

   Výše uvedený způsob psaní komentáře je správný, ale nedoporučuje se, protože pokud je komentář větší než jeden řádek, musíte napsat víceřádkové komentáře. Lepší způsob psaní je použití víceřádkového komentáře jako:

   / * Toto je komentář. Použijte jej v případě potřeby a přesně * /

2. Jednořádkový komentář lze napsat do samostatného řádku nebo spolu s kódem do stejného řádku. Doporučuje se však použít komentáře v samostatném řádku.
   Příklad:

    nechť pi = 3.14159 // uloží 3,14 do proměnné pi

   Tento způsob psaní komentářů je platný. Je ale lepší napsat komentář do samostatného řádku jako:

    // ukládá 3,14 do proměnné pi let pi = 3,14159 

3. I když jste jediným vývojářem v týmu a jste jediný, kdo kód píše, pokud je nekomentovaný, budete se jen těžko snažit zjistit jeho účel v programu. Použijte jej tedy přesně a uveďte smysluplný popis.
4. Udělejte komentář velmi jednoduchým a smysluplným.
5. Nepište zbytečné komentáře ke svému kódu.
6. Ve většině případů používejte komentáře k vysvětlení „proč“, nikoli „jak“.