Komentáře v Pythonu jsou řádky v kódu, které interpret ignoruje během provádění programu.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Komentáře zvyšují čitelnost kódu a pomáhají programátorům velmi pečlivě porozumět kódu. Pomáhá také při spolupráci s ostatními vývojáři, protože přidávání komentářů usnadňuje vysvětlení kódu.
Typy komentářů v Pythonu
V Pythonu existují tři typy komentářů:
- Jednořádkové komentáře
- Víceřádkové komentáře
- Smyčcové literály
- Komentáře k docstringu
Komentáře v Pythonu
Na příkladu je to vidět Krajta Při provádění programu jsou komentáře ignorovány interpretem.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Výstup:
geeksforgeeks>
Proč se v Pythonu používají komentáře?
Komentáře byly nedílnou součástí programovacích jazyků a každý jazyk má jiné způsoby použití komentářů.
Stejně jako každý jiný jazyk, komentáře v Pythonu slouží k následujícímu účelu:
- Vylepšete čitelnost kódu
- Vysvětlení kódu ostatním
- Pochopení kódu, pokud je po nějaké době prostudováno
- Dokumentování kroků a potřeb pro funkci
- Sdílení kódu s ostatními vývojáři
- Spolupráce s více lidmi.
Typy komentářů v Pythonu
Pojďme objevit různé typy komentářů, jak je používat a kdy je použít?
1. Jednořádkový Komentáře
- Jednořádkový komentář v Pythonu začíná symbolem hashtag (#) bez mezer a trvá až do konce řádku.
- Pokud komentář přesahuje jeden řádek, vložte hashtag na další řádek a pokračujte v komentáři Python.
- Jednořádkové komentáře Pythonu se ukázaly jako užitečné pro poskytování krátkých vysvětlení proměnných, deklarací funkcí a výrazů. Podívejte se na následující fragment kódu demonstrující jednořádkový komentář:
Příklad:
Python3
prohlášení k případu verilog
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Výstup
techcodeview.com>
2. Víceřádkové komentáře
Python nenabízí možnost pro víceřádkové komentáře . Existují však různé způsoby, kterými můžeme psát víceřádkové komentáře.
a) Víceřádkové komentáře pomocí více hashtagů (#)
Pro psaní víceřádkových komentářů v Pythonu můžeme použít více hashtagů (#). Každý řádek bude považován za jednořádkový komentář.
Python3
java otevírání souboru
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Výstup
Multiline comments>
Zkontrolujte také: Zajímavý fakt o víceřádkových komentářích v Pythonu
3. Smyčcové literály
Python ignoruje řetězcové literály které nejsou přiřazeny k proměnné, takže tyto řetězcové literály můžeme použít jako komentáře Pythonu .
a) Jednořádkové komentáře pomocí řetězcových literálů
Při provádění výše uvedeného kódu vidíme, že nebude žádný výstup, takže použijeme řetězce s trojité uvozovky () jako víceřádkové komentáře.
Python3
'This will be ignored by Python'> |
>
>
b) Víceřádkové komentáře pomocí řetězcových literálů
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Výstup
Multiline comments>
4. Docstring
- Python docstring je řetězcové literály s trojitými uvozovkami, které se objevují hned za funkcí.
- Používá se ke spojení dokumentace, která byla napsána s moduly, funkcemi, třídami a metodami Pythonu.
- Je přidán přímo pod funkce, moduly nebo třídy, aby popisoval, co dělají. V Pythonu je pak docstring zpřístupněn prostřednictvím atributu __doc__.
Pří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__)> |
>
úplný obvod sčítačky
>
Výstup:
Multiplies the value of a and b>
Výhody komentářů v Pythonu
Komentáře se obecně používají pro následující účely:
- Čitelnost kódu
- Vysvětlení kódu nebo metadat projektu
- Zabránit spuštění kódu
- Zahrnout zdroje
Správný způsob psaní komentářů
Komentáře slouží především k vysvětlení vašeho kódu. Vývojáři používají zdravé postupy psaní komentářů pro lepší pochopení kódu.
Některé z tipů, kterými se můžete řídit, aby byly vaše komentáře efektivní, jsou:
- Komentáře by měly být krátké a přesné.
- Komentáře používejte pouze v případě potřeby, nezahlcujte kód komentáři.
- Komentář by měl mít nějaký význam.
- Vyhněte se psaní obecných nebo základních komentářů.
- Pište komentáře, které jsou samozřejmé.
Probrali jsme vše o komentářích v Pythonu, o tom, jak psát komentáře v Pythonu, o typech komentářů, jaké jsou jeho výhody a o správném způsobu psaní komentářů.
Přečtěte si také: Jak psát komentáře v Pythonu3?