Komentáre v Pythone sú riadky v kóde, ktoré interpret ignoruje počas vykonávania programu.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Komentáre zlepšujú čitateľnosť kódu a pomáhajú programátorom veľmi pozorne porozumieť kódu. Pomáha tiež pri spolupráci s ostatnými vývojármi, pretože pridávanie komentárov uľahčuje vysvetlenie kódu.
Typy komentárov v Pythone
V Pythone existujú tri typy komentárov:
- Jednoriadkové komentáre
- Viacriadkové komentáre
- Strunové literály
- Komentáre k docstringu
Komentáre v Pythone
Na príklade je to vidieť Python Pri vykonávaní programu sú komentáre ignorované interpretom.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Výkon:
geeksforgeeks>
Prečo sa v Pythone používajú komentáre?
Komentáre sú neoddeliteľnou súčasťou programovacích jazykov a každý jazyk má iné spôsoby použitia komentárov.
Rovnako ako každý iný jazyk, komentáre v Pythone slúžia na nasledujúci účel:
- Zlepšite čitateľnosť kódu
- Vysvetlenie kódu ostatným
- Pochopenie kódu, ak si ho preštudujete po určitom čase
- Zdokumentovanie krokov a potrieb funkcie
- Zdieľanie kódu s ostatnými vývojármi
- Spolupráca s viacerými ľuďmi.
Typy komentárov v Pythone
Poďme objaviť rôzne typy komentárov, ako ich používať a kedy ich použiť?
1. Jednoriadkový Komentáre
- Jednoriadkový komentár Pythonu začína symbolom hashtag (#) bez medzier a trvá do konca riadku.
- Ak komentár presahuje jeden riadok, vložte hashtag na ďalší riadok a pokračujte v komentári Pythonu.
- Jednoriadkové komentáre Pythonu sa ukázali ako užitočné na poskytovanie krátkych vysvetlení premenných, deklarácií funkcií a výrazov. Pozrite si nasledujúci útržok kódu demonštrujúci jednoriadkový komentár:
Príklad:
Python3
hrubá bodka
mravec vs človek
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Výkon
techcodeview.com>
2. Viacriadkové komentáre
Python neposkytuje možnosť pre viacriadkové komentáre . Existujú však rôzne spôsoby, ktorými môžeme písať viacriadkové komentáre.
a) Viacriadkové komentáre pomocou viacerých hashtagov (#)
Na písanie viacriadkových komentárov v Pythone môžeme použiť viacero hashtagov (#). Každý riadok bude považovaný za jednoriadkový komentár.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Výkon
Multiline comments>
Skontrolujte tiež: Zaujímavý fakt o viacriadkových komentároch Pythonu
3. Strunové literály
Python ignoruje reťazcové literály ktoré nie sú priradené k premennej, takže tieto reťazcové literály môžeme použiť ako komentáre Pythonu .
a) Jednoriadkové komentáre pomocou reťazcových literálov
Pri vykonávaní vyššie uvedeného kódu vidíme, že nebude žiadny výstup, takže použijeme reťazce s trojité úvodzovky () ako viacriadkové komentáre.
Python3
'This will be ignored by Python'> |
>
>
b) Viacriadkové komentáre pomocou reťazcových literálov
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
python __name__
>Výkon
Multiline comments>
4. Docstring
- Python docstring je reťazcové literály s trojitými úvodzovkami, ktoré sa objavia hneď za funkciou.
- Používa sa na priradenie dokumentácie, ktorá bola napísaná s modulmi, funkciami, triedami a metódami Pythonu.
- Pridáva sa priamo pod funkcie, moduly alebo triedy, aby popisovali, čo robia. V Pythone je potom docstring sprístupnený prostredníctvom atribútu __doc__.
Príklad:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Výkon:
Multiplies the value of a and b>
Výhody komentárov v Pythone
Komentáre sa vo všeobecnosti používajú na tieto účely:
- Čitateľnosť kódu
- Vysvetlenie kódu alebo metaúdajov projektu
- Zabrániť spusteniu kódu
- Ak chcete zahrnúť zdroje
Správny spôsob písania komentárov
Komentáre slúžia hlavne na vysvetlenie vášho kódu. Vývojári používajú zdravé postupy písania komentárov na lepšie pochopenie kódu.
Niektoré z tipov, ktoré môžete dodržiavať, aby boli vaše komentáre efektívne, sú:
- Komentáre by mali byť krátke a presné.
- Komentáre používajte iba v prípade potreby, nezaťažujte kód komentármi.
- Komentár by mal mať nejaký význam.
- Vyhnite sa písaniu všeobecných alebo základných komentárov.
- Napíšte komentáre, ktoré sú samovysvetľujúce.
Diskutovali sme o všetkom o komentároch v jazyku Python, o tom, ako písať komentáre v jazyku Python, o typoch komentárov, aké sú jeho výhody a o správnom spôsobe písania komentárov.
Prečítajte si tiež: Ako písať komentáre v Pythone3?