V tomto tutoriále sa naučíme vytvárať komentáre v Pythone pomocou príkladov.
Video: Komentáre v Pythone
Komentáre sú popisy, ktoré pomáhajú programátorom lepšie pochopiť zámer a funkčnosť programu.
Sú interpretom Pythonu úplne ignorovaní.
Výhody použitia komentárov
Používanie komentárov v programoch robí náš kód zrozumiteľnejším. Robí program čitateľnejším, čo nám pomáha pamätať si, prečo boli napísané určité bloky kódu.
Okrem toho je možné použiť komentáre na ignorovanie určitého kódu pri testovaní ďalších blokov kódu. To ponúka jednoduchý spôsob, ako zabrániť vykonaniu niektorých riadkov alebo napísať rýchly pseudokód pre program.
Jednoriadkové komentáre v Pythone
V Pythone používame hash symbol #na napísanie jednoriadkového komentára.
Príklad 1: Písanie jednoriadkových komentárov
# printing a string print('Hello world')
Výkon
Ahoj svet
Tu je komentár:
# printing a string
Tento riadok je interpretom Pythonu ignorovaný.
Všetko, čo príde potom, #sa ignoruje. Vyššie uvedený program teda môžeme napísať do jedného riadku ako:
print('Hello world') #printing a string
Výstup tohto programu bude rovnaký ako v príklade 1 . Tlmočník ignoruje celý text nasledujúci po #.
Viacriadkové komentáre v Pythone
Python neponúka samostatný spôsob písania viacriadkových komentárov. Existujú však aj iné spôsoby, ako tento problém obísť.
Na #začiatku každého riadku komentára môžeme použiť viac riadkov.
Príklad 2: Použitie viacerých #
# it is a # multiline # comment
Tu sa každý riadok považuje za jeden komentár a všetky sú ignorované.
Reťazcové literály pre viacriadkové komentáre
Aj keď v Pythone neexistuje žiadny jedinečný spôsob písania viacriadkových komentárov, vieme, že interpret Pythonu ignoruje reťazcové literály, ktoré nie sú priradené k premennej.
Môžeme teda dokonca napísať jednoriadkový komentár ako:
#this is a comment 'this is an unassigned string as a comment '
Tu vidíme, že druhý riadok programu je reťazec, ale nie je priradený k žiadnej premennej alebo funkcii. Tlmočník teda reťazec ignoruje.
Podobným spôsobom môžeme na napísanie viacriadkových komentárov použiť viacriadkové reťazce (trojité úvodzovky).
Znak úvodzovky môže byť buď 'alebo ".
Príklad 3: Používanie reťazcových literálov na písanie viacriadkových komentárov
''' I am a multiline comment! ''' print("Hello World")
Viacriadkový reťazec tu nie je priradený k žiadnej premennej, takže ho tlmočník ignoruje. Aj keď to nie je technicky viacriadkový komentár, dá sa použiť ako jeden.
Python docstrings
Podľa konvencie sú trojité úvodzovky, ktoré sa objavia hneď po definovaní funkcie, metódy alebo triedy, docstrings (dokumentačné reťazce).
Docstrings sú spojené s objektmi a je k nim prístup pomocou __doc__atribútu.
Ak sa chcete dozvedieť viac, navštívte dokumentačné reťazce Python.
Ako písať lepšie komentáre?
- Pomocou komentárov popíšte, čo funkcia robí, a nie konkrétne podrobnosti o tom, ako funkcia funguje.
- Pokúste sa odstrániť čo najviac nadbytočných komentárov. Skúste napísať kód, ktorý sa dokáže vysvetliť, a to pomocou lepšej voľby názvu funkcie / premennej.
- Snažte sa, aby boli komentáre čo najkratšie a najstručnejšie.
