V tomto článku se ponoříme do konceptu víceřádkových komentářů v Pythonu a poskytneme komplexní definici spolu s ilustrativními příklady v programovacím jazyce Python o tom, jak komentovat více řádků v Krajta .

Co je víceřádkový komentář v Pythonu?

Víceřádkové komentáře v Pythonu odkazují na blok textu nebo příkazy, které se v kódu používají pro účely vysvětlení nebo dokumentace. Na rozdíl od jednořádkových komentářů označených symbolem hash (#) jsou víceřádkové komentáře uzavřeny trojitými dvojitými uvozovkami (``) nebo trojitými jednoduchými uvozovkami (`'`). Tyto komentáře se často používají k poskytnutí podrobných vysvětlení, dokumentace nebo poznámek ke kódu a mohou zahrnovat více řádků. Zatímco Python nemá specifickou syntaxi pro víceřádkové komentáře, použití trojitých uvozovek dosahuje podobného efektu, protože interpret ignoruje uzavřený text.

Typy víceřádkových komentářů v Pythonu

Existují dva způsoby, jak můžeme přidat víceřádkové komentáře Pythonu do našeho kódu. Jsou následující:

• Po sobě jdoucí jednořádkový komentář
• Použití víceřádkového řetězce jako komentáře
• Použití metody zpětného lomítka

Zakomentujte více řádků v Pythonu pomocí po sobě jdoucích jednořádkových komentářů

v Krajta , znak hash (#) se používá pro komentář na řádku. Jednořádkový komentáře v Pythonu nemusí být k vysvětlení kódu pouze text, lze je také použít k zabránění Pythonu ve spouštění kódu. Znak hash by měl být umístěn před každým řádkem, aby byl v Pythonu považován za víceřádkové komentáře.

javascript

Příklad: Po sobě jdoucí jednořádkový komentář

Zde první dva řádky obsahují znak hash (#) a tlumočník zabrání provedení dvou řádků. Poté vytiskne komentáře Pythonu a nakonec zabrání spuštění posledního řádku.

# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Výstup:

Python Comments>

Zakomentujte více řádků v Pythonu pomocí víceřádkového řetězce jako komentáře

Víceřádkové komentáře Pythonu lze také uzavřít do oddělovače (). Mezi oddělovači by opět nemělo být žádné prázdné místo (). Jsou užitečné, když se text komentáře nevejde na jeden řádek, a proto musí být rozložen přes řádky. Tento typ řetězcového literálu je ignorován, protože není přiřazen k žádné proměnné. K těmto řetězcům můžeme přistupovat pomocí __doc__.

Příklad: Použití víceřádkového řetězce jako komentáře

Víceřádkové komentáře se používají pro komentování více než jednoho řádku. První řádek je jednořádkový komentář. Druhý a třetí řádek lze okomentovat pomocí trojitých uvozovek(). Tím se zabrání spuštění výše uvedeného kódu. Nakonec ve výstupu vytiskne Matematiku. Pokud jsou však tyto víceřádkové komentáře Pythonu umístěny přímo za podpisem funkce nebo třídy, změní se v docstrings .

# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Výstup:

Mathematics>

Zakomentujte více řádků v Pythonu pomocí metody zpětného lomítka

Metoda vytváření víceřádkových komentářů v Pythonu zahrnuje použití zpětného lomítka (``) na konci každého řádku, aby se využila funkce pokračování řádku, čímž se umožní, aby se komentář rozšířil na další řádek. Tato metoda pokračování řádku je méně běžná než jiné přístupy, jako jsou po sobě jdoucí jednořádkové komentáře nebo víceřádkové řetězce, a primárně se používá pro účely čitelnosti kódu, když je nutné rozdělit komentář na více řádků.

Příklad : V tomto příkladu komentáře začínající na#>jsou rozšířeny na více řádků pomocí zpětného lomítka (>) na konci každého řádku. Zpětné lomítko označuje, že komentář pokračuje na dalším řádku. Tato metoda může být užitečná pro zlepšení čitelnosti kódu, když máte dlouhé komentáře.

stromová mapa

# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Výstup :

Hello, World!>

Docstrings v Pythonu

The dokumentační řetězec je vestavěná funkce Pythonu, která se používá ke spojení dokumentace, která byla napsána s moduly, funkcemi, třídami a metodami jazyka Python. 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 Python __doc__ atribut.

Příklad: Docstrings v Pythonu

V tomto příkladu jsme po definování funkce multiply() deklarovali komentář docstring pomocí trojitých uvozovek. Poté vytiskneme docstring pomocí atributu __doc__.

def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Výstup:

Multiplies the value of a and b>

Rozdíl mezi komentáři a dokumentačním řetězcem v Pythonu

Podívejme se na rozdíl mezi komentáři Python a Docstring: