V tomto kurzu se naučíme vytvářet komentáře v Pythonu pomocí příkladů.
Video: Komentáře v Pythonu
Komentáře jsou popisy, které pomáhají programátorům lépe porozumět záměru a funkčnosti programu.
Překladač Pythonu je zcela ignoruje.
Výhody používání komentářů
Díky použití komentářů v programech je náš kód srozumitelnější. Díky tomu je program čitelnější, což nám pomáhá pamatovat si, proč byly napsány určité bloky kódu.
Kromě toho lze komentáře také použít k ignorování některého kódu při testování dalších bloků kódu. To nabízí jednoduchý způsob, jak zabránit provedení některých řádků nebo napsat rychlý pseudokód pro program.
Jednořádkové komentáře v Pythonu
V Pythonu používáme hash symbol #k napsání jednořádkového komentáře.
Příklad 1: Psaní jednořádkových komentářů
# printing a string print('Hello world')
Výstup
Ahoj světe
Zde je komentář:
# printing a string
Tento řádek je interpretem Pythonu ignorován.
Vše, co přijde poté, #je ignorováno. Výše uvedený program tedy můžeme napsat do jednoho řádku jako:
print('Hello world') #printing a string
Výstup tohoto programu bude stejný jako v příkladu 1 . Tlumočník ignoruje celý text za #.
Víceřádkové komentáře v Pythonu
Python nenabízí samostatný způsob psaní víceřádkových komentářů. Existují však i jiné způsoby, jak tento problém obejít.
Můžeme použít #na začátku každého řádku komentáře na více řádcích.
Příklad 2: Použití více #
# it is a # multiline # comment
Zde je každý řádek považován za jeden komentář a všechny jsou ignorovány.
Řetězcové literály pro víceřádkové komentáře
I když v Pythonu neexistuje žádný jedinečný způsob psaní víceřádkových komentářů, víme, že interpret Pythonu ignoruje řetězcové literály, které nejsou přiřazeny proměnné.
Můžeme tedy dokonce napsat jednořádkový komentář jako:
#this is a comment 'this is an unassigned string as a comment '
Zde vidíme, že druhý řádek programu je řetězec, ale není přiřazen žádné proměnné ani funkci. Tlumočník tedy řetězec ignoruje.
Podobným způsobem můžeme k psaní víceřádkových komentářů použít víceřádkové řetězce (trojité uvozovky).
Znak nabídky může být buď 'nebo ".
Příklad 3: Použití řetězcových literálů k psaní víceřádkových komentářů
''' I am a multiline comment! ''' print("Hello World")
Řetězec více řádků zde není přiřazen k žádné proměnné, takže jej interpret ignoruje. I když se nejedná o technicky víceřádkový komentář, lze jej použít jako jeden.
Python docstrings
Podle konvence jsou trojité uvozovky, které se objeví hned po definici funkce, metody nebo třídy, docstrings (dokumentace strings).
Docstrings jsou spojeny s objekty a lze k nim přistupovat pomocí __doc__atributu.
Další informace najdete v dokumentačních řetězcích Pythonu.
Jak psát lepší komentáře?
- Pomocí komentářů popište, co funkce dělá, a nikoli konkrétní podrobnosti o tom, jak to funkce dělá.
- Pokuste se odstranit co nejvíce nadbytečných komentářů. Zkuste napsat kód, který se dokáže vysvětlit pomocí lepší volby názvu funkce / proměnné.
- Pokuste se komentáře vytvořit co nejkratší a nejstručnější.
