Comentarios de varias líneas en Python

Python Comments se usa para la declaración no ejecutable, ayuda a que el código sea legible. Y comentarios multilínea en Python una línea múltiple de comentarios.

Formas de lograr comentarios de varias líneas en Python

• Comentario consecutivo de una sola línea
• Usar una string de varias líneas como comentario

Comentario consecutivo de una sola línea

El carácter hash (#) se usa para comentar la línea en el programa de Python. Los comentarios no tienen que ser texto para explicar el código, también se pueden usar para evitar que Python ejecute código. 

El carácter hash debe colocarse antes de la línea que se va a comentar. Los comentarios consecutivos de una sola línea se pueden usar como comentarios de varias líneas en Python.

Ejemplo: Cómo hacer comentarios de una sola línea en Python

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

Producción:

Python Comments

Aquí, las dos primeras líneas contienen el carácter hash (#) y el intérprete evita que se ejecuten las dos líneas. Luego imprime los “Comentarios de Python” y finalmente, evitará la ejecución de la última línea.

Usar una string de varias líneas como comentario

El comentario de varias líneas de Python es un fragmento de texto encerrado en un delimitador («»») en cada extremo del comentario. De nuevo, no debe haber espacios en blanco entre los delimitadores («»»). 

Son útiles cuando el texto del comentario no cabe en una sola línea; por lo tanto, necesita extenderse a través de las líneas. Los comentarios o párrafos de varias líneas sirven como documentación para otras personas que leen su código. Consulte el siguiente fragmento de código que muestra un comentario de varias líneas:

Ejemplo: Cómo hacer comentarios de varias líneas en Python

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

Producción:

Mathematics

 En el ejemplo anterior, los comentarios de varias líneas se utilizan para comentar en más de una línea. La primera línea es un comentario de una sola línea. La segunda y tercera línea se pueden comentar usando comillas triples («»» «»»»). Esto impide la ejecución del código anterior. Finalmente, imprime «Matemáticas» en la salida. Sin embargo, si estos comentarios de varias líneas se colocan directamente después de una firma de función o clase, se convierten en docstrings . 

Docstring es una función integrada de Python, que se utiliza para asociar documentación que se ha escrito con módulos, funciones, clases y métodos de Python. Se agrega justo debajo de las funciones, módulos o clases para describir lo que hacen. En Python, la string de documentos está disponible a través del atributo __doc__. 

Ejemplo: 

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

Producción:

Multiplies the value of a and b