¿Cómo creamos comentarios de varias líneas en Python?

Los comentarios son piezas de información presentes en medio del código que permiten a un desarrollador explicar su trabajo a otros desarrolladores. Hacen que el código sea más legible y, por lo tanto, más fácil de depurar. 

Comentario en línea

Un comentario en línea es un comentario de una sola línea y está en la misma línea que una declaración. Se crean poniendo un símbolo ‘#’ antes del texto.

Sintaxis:

# This is a single line comment

Ejemplo:

def my_fun():
   
    # prints Geeksforgeeks on the console
    print("GeeksforGeeks")
 
# function call
my_fun()

Producción:

GeeksforGeeks

Nota: aunque no es necesario, según Python, debe haber un solo espacio entre el símbolo # y el texto del comentario y al menos 2 espacios entre el comentario y la declaración.

Bloquear comentario

Los comentarios de bloque en Python generalmente se refieren al código que los sigue y están destinados al mismo nivel que ese código. Cada línea de comentario de bloque comienza con un símbolo ‘#’.

Sintaxis:

# This is a block comment 
# Each line of a block comment is intended to the same level

Ejemplo:

def my_fun(i):
   
    # prints GFG on the console until i
    # is greater than zero dercrements i
    # by one on each iteration
    while i > 0:
        print("GFG")
        i = i-1
 
 
# calling my_fun
# it will print GFG 5 times on the console
my_fun(5)

Producción:

GFG
GFG
GFG
GFG
GFG

strings de documentación

La string de documentación es una string literal que aparece como la primera declaración en una definición de módulo, función, clase o método. Explican lo que se puede lograr con la pieza de código, pero no deben contener información sobre la lógica detrás del código. Las strings de documentación se convierten en el atributo especial __doc__ de ese objeto, lo que las hace accesibles como un atributo de objeto de tiempo de ejecución. Se pueden escribir de dos formas:

1. String de documentación de una línea: 

Sintaxis: 

"""This is a one-line docstring."""

o

'''This is one-line docstring.'''

Ejemplo:

def my_fun():
    """Greets the user."""
    print("Hello Geek!")
 
     
# function call
my_fun()
 
# help function on my_fun
help(my_fun)

Producción: 

Hello Geek!
Help on function my_fun in module __main__:

my_fun()
    Greets the user.

Tenga en cuenta que para las strings de documentos de una línea, las comillas de cierre están en la misma línea que las comillas de apertura.

2. String de documentos de varias líneas:

Sintaxis:

"""This is a multi-line docstring.

The first line of a multi-line doscstring consist of a summary.
It is followed by one or more elaborate description.
"""

Ejemplo:

def my_fun(user):
    """Greets the user
 
    Keyword arguments:
    user -- name of user
    """
    print("Hello", user+"!")
 
# function call
my_fun("Geek")
 
# help function on my_fun
help(my_fun)

Producción:

Hello Geek!
Help on function my_fun in module __main__:

my_fun(user)
    Greets the user
    
    Keyword arguments:
    user -- name of user

Las comillas de cierre deben estar en una sola línea, mientras que las comillas de apertura pueden estar en la misma línea que la línea de resumen. 

Algunas mejores prácticas para escribir docstrings:

• Utilice comillas dobles triples en aras de la coherencia.
• No hay espacios adicionales antes o después de docstring.
• A diferencia de los comentarios, debe terminar con un punto.