En aquest article, aprofundirem en el concepte de comentaris multilínia a Python, proporcionant una definició completa juntament amb exemples il·lustratius en el llenguatge de programació Python sobre Com comentar múltiples línies en Python .

replaceall en cadena java

Què és un comentari multilínia a Python?

Els comentaris multilínia a Python fan referència a un bloc de text o declaracions que s'utilitzen amb finalitats explicatives o de documentació dins del codi. A diferència dels comentaris d'una sola línia indicats amb el símbol hash (#), els comentaris de diverses línies estan tancats entre cometes dobles triples (``) o cometes simples triples (`'`). Aquests comentaris s'utilitzen sovint per proporcionar explicacions detallades, documentació o notes sobre el codi, i poden abastar diverses línies. Tot i que Python no té una sintaxi específica per als comentaris multilínia, l'ús de cometes triples aconsegueix un efecte similar, ja que l'intèrpret ignora el text adjunt.

Tipus de comentaris multilínia en Python

Hi ha dues maneres d'afegir comentaris multilínia de Python al nostre codi. Són els següents:

• Comentari consecutiu d'una sola línia
• Utilitzant una cadena de diverses línies com a comentari
• Utilitzant el mètode de la barra invertida

Comenta diverses línies a Python utilitzant el comentari d'una sola línia consecutiu

En Python , el caràcter hash (#) s'utilitza per comentar la línia. Una sola línia comentaris en Python no han de ser només text per explicar el codi, també es poden utilitzar per evitar que Python executi codi. El caràcter hash s'ha de col·locar abans de cada línia per ser considerat com a comentaris multilínia a Python.

Exemple: comentari consecutiu d'una sola línia

Aquí, les dues primeres línies contenen un caràcter hash (#) i l'intèrpret impedeix l'execució de les dues línies. A continuació, imprimeix els comentaris de Python i, finalment, evitarà l'execució de l'última línia.

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

Sortida:

Python Comments>

Comenta diverses línies a Python utilitzant una cadena de múltiples línies com a comentari

Els comentaris multilínia de Python també es poden incloure en un delimitador (). De nou, no hi hauria d'haver cap espai en blanc entre els delimitadors (). Són útils quan el text del comentari no encaixa en una línia i, per tant, s'ha d'estendre entre línies. Aquest tipus de literal de cadena s'ignora ja que no està assignat a cap variable. Podem accedir a aquestes cadenes mitjançant __doc__.

cordes al c

Exemple: Ús d'una cadena multilínia com a comentari

Els comentaris de diverses línies s'utilitzen per comentar més d'una línia. La primera línia és un comentari d'una sola línia. La segona i la tercera línies es poden comentar utilitzant cometes triples ( ). Això impedeix l'execució del codi anterior. Finalment, imprimeix Matemàtiques a la sortida. Tanmateix, si aquests comentaris multilínia de Python es col·loquen directament després d'una funció o signatura de classe, aquests es converteixen en docstrings .

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

Sortida:

Mathematics>

Comenta diverses línies a Python mitjançant el mètode de barra invertida

Un mètode per crear comentaris multilínia a Python implica utilitzar la barra invertida (``) al final de cada línia per utilitzar la funció de continuació de línia, permetent així que el comentari s'estengui a la línia següent. Aquest mètode de continuació de línia és menys comú que altres enfocaments, com ara els comentaris consecutius d'una sola línia o les cadenes de diverses línies i s'utilitza principalment per a finalitats de llegibilitat del codi quan és necessari dividir un comentari en diverses línies.

cadena.subcadena java

Exemple : En aquest exemple, els comentaris comencen per#>s'estenen a diverses línies utilitzant la barra invertida (>) al final de cada línia. La barra invertida indica que el comentari continua a la línia següent. Aquest mètode pot ser útil per millorar la llegibilitat del codi quan teniu comentaris llargs.

# 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!')>

Sortida:

Hello, World!>

Docstrings en Python

El docstring és una característica integrada de Python, que s'utilitza per associar documentació que s'ha escrit amb mòduls, funcions, classes i mètodes de Python. S'afegeix just a sota de les funcions, mòduls o classes per descriure el que fan. A Python, la cadena de documents es posa a disposició mitjançant el fitxer Python __doc__ atribut.

Exemple: Docstrings a Python

En aquest exemple, després de definir la funció multiplicar (), vam declarar un comentari de cadena de document utilitzant les cometes triples. A continuació, estem imprimint la docstring utilitzant l'atribut __doc__.

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

Sortida:

codi de Fibonacci java

Multiplies the value of a and b>

Diferència entre comentaris i Docstring a Python

Vegem la diferència entre els comentaris de Python i Docstring: