Python Multi-line Kommentarer: de To Beste Alternativene


Alternativ 2: Bruk av Multi-line Strenger som Kommentarer

et Annet alternativ for å skrive «riktig» multi-line kommentarer i Python er å bruke multi-line strenger med """ syntaks på kreative måter. Her er et eksempel:

"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42

Som du kan se, kan du bruke trippel-sitert strenger å skape noe som ligner en multiline kommentar i Python., Du trenger bare å sørge for at du innrykk på første """ på riktig måte, ellers vil du få en SyntaxError. For eksempel, hvis du ønsker å angi en blokk kommentar inne i en funksjon med denne teknikken du trenger å gjøre det som dette:

husk Bare at denne teknikken ikke lage «ekte» kommentarer. Dette rett og slett setter inn en tekst konstant som ikke gjør noe. Det er det samme som å sette inn et vanlig single-line string et sted i koden din og aldri få tilgang til det.,

Imidlertid er en slik foreldreløse string konstant vil ikke dukke opp i bytecode, effektivt og snu den til en multi-line kommentar. Her er bevis på at ubrukte strengen vises ikke i CPython bytecode-demontering:

Imidlertid være forsiktig hvor du plasserer disse «kommentarer» i koden., Hvis strengen følger rett etter en funksjon signatur, en klasse definisjon, eller i starten av en modul, det blir til en docstring som har en annen mening helt i Python:

Docstrings («dokumentasjon strenger») lar deg knytte lesbar dokumentasjon med Python-moduler, funksjoner, klasser og metoder. De er forskjellige fra kildekoden kommentarer:

Et kommentaren er fjernet av parser, mens en docstring ender opp i bytecode og er forbundet med dokumentert objekt. Det kan også nås programmatisk ved kjøring.,

Som jeg sa tidligere, den eneste måten å få «ekte» multi-line kommentarer i Python som blir ignorert av parseren er å bruke flere # single-line kommentarer.

jeg skal innrømme jeg ble litt overrasket over å finne denne «falske» blokk kommenterer stil ble støttet av Guido van Rossum, skaperen av Python:

Legg igjen en kommentar

Din e-postadresse vil ikke bli publisert. Obligatoriske felt er merket med *