V tomto článku sa ponoríme do konceptu viacriadkových komentárov v Pythone a poskytneme komplexnú definíciu spolu s názornými príkladmi v programovacom jazyku Python o tom, ako komentovať viac riadkov v Python .

Čo je viacriadkový komentár v Pythone?

Viacriadkové komentáre v Pythone odkazujú na blok textu alebo príkazy, ktoré sa používajú na účely vysvetlenia alebo dokumentácie v kóde. Na rozdiel od jednoriadkových komentárov označených symbolom hash (#), viacriadkové komentáre sú uzavreté trojitými dvojitými úvodzovkami (``) alebo trojitými jednoduchými úvodzovkami (`'`). Tieto komentáre sa často používajú na poskytnutie podrobných vysvetlení, dokumentácie alebo poznámok o kóde a môžu zahŕňať viacero riadkov. Zatiaľ čo Python nemá špecifickú syntax pre viacriadkové komentáre, použitím trojitých úvodzoviek sa dosiahne podobný efekt, pretože tlmočník ignoruje priložený text.

Typy viacriadkových komentárov v Pythone

Existujú dva spôsoby, ktorými môžeme do nášho kódu pridať viacriadkové komentáre Pythonu. Sú nasledovné:

• Po sebe idúci jednoriadkový komentár
• Použitie viacriadkového reťazca ako komentára
• Použitie metódy spätného lomítka

Komentujte viac riadkov v Pythone pomocou po sebe idúcich jednoriadkových komentárov

In Python , znak hash (#) sa používa na komentár k riadku. Jedna čiara komentáre v Pythone nemusia byť len textom na vysvetlenie kódu, môžu sa použiť aj na zabránenie Pythonu spustiť kód. Znak hash by mal byť umiestnený pred každým riadkom, aby sa v Pythone považoval za viacriadkové komentáre.

Príklad: Po sebe idúci jednoriadkový komentár

Tu prvé dva riadky obsahujú znak hash (#) a tlmočník zabráni vykonaniu týchto dvoch riadkov. Potom vytlačí komentáre Pythonu a nakoniec zabráni vykonaniu posledného riadku.

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

Výkon:

Python Comments>

Komentujte viac riadkov v Pythone pomocou viacriadkového reťazca ako komentára

Viacriadkové komentáre Pythonu môžu byť tiež uzavreté v oddeľovači (). Medzi oddeľovačmi by opäť nemalo byť žiadne prázdne miesto (). Sú užitočné, keď sa text komentára nezmestí do jedného riadku, a preto musí byť rozložený cez riadky. Tento typ reťazcového literálu sa ignoruje, pretože nie je priradený žiadnej premennej. K týmto reťazcom môžeme pristupovať pomocou __doc__.

Príklad: Použitie viacriadkového reťazca ako komentára

Viacriadkové komentáre sa používajú na komentovanie viac ako jedného riadku. Prvý riadok je jednoriadkový komentár. Druhý a tretí riadok je možné okomentovať pomocou trojitých úvodzoviek(). Tým sa zabráni vykonaniu vyššie uvedeného kódu. Nakoniec vo výstupe vytlačí Matematiku. Ak sú však tieto viacriadkové komentáre Pythonu umiestnené priamo za podpisom funkcie alebo triedy, potom sa zmenia na dokumentačné reťazce .

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

Výkon:

Mathematics>

Zakomentujte viac riadkov v Pythone pomocou metódy spätného lomítka

Metóda vytvárania viacriadkových komentárov v Pythone zahŕňa použitie spätnej lomky (``) na konci každého riadku, aby sa využila funkcia pokračovania riadku, čím sa umožní, aby sa komentár rozšíril na ďalší riadok. Táto metóda pokračovania riadkov je menej bežná ako iné prístupy, ako sú po sebe idúce jednoriadkové komentáre alebo viacriadkové reťazce, a primárne sa používa na účely čitateľnosti kódu, keď je potrebné rozdeliť komentár na viacero riadkov.

Príklad : V tomto príklade komentáre začínajúce na#>sú rozšírené na viacero riadkov pomocou spätnej lomky (>) na konci každého riadku. Opačná lomka označuje, že komentár pokračuje na ďalšom riadku. Táto metóda môže byť užitočná na zlepšenie čitateľnosti kódu, keď máte dlhé komentáre.

# 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ýkon :

Hello, World!>

Docstrings v Pythone

The dokumentačný reťazec je vstavaná funkcia Pythonu, ktorá sa používa na priradenie dokumentácie, ktorá bola napísaná s modulmi, funkciami, triedami a metódami jazyka Python. Pridáva sa priamo pod funkcie, moduly alebo triedy, aby popisovali, čo robia. V Pythone je potom dokumentačný reťazec sprístupnený cez Python __doc__ atribút.

Príklad: Docstrings v Pythone

V tomto príklade, po definovaní funkcie multiply() sme deklarovali komentár docstring pomocou trojitých úvodzoviek. Potom vytlačíme reťazec dokumentu pomocou atribútu __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ýkon:

Multiplies the value of a and b>

Rozdiel medzi komentármi a dokumentačným reťazcom v Pythone

Pozrime sa na rozdiel medzi komentármi Python a Docstring: