¿Cómo escribir comentarios en Python3?

Los comentarios son notas de texto añadidas al programa para proporcionar información explicativa sobre el código fuente. Se utilizan en un lenguaje de programación para documentar el programa y recordar a los programadores las cosas complicadas que acaban de hacer con el código y también ayudan a la generación posterior a comprender y mantener el código. El compilador las considera sentencias no ejecutables. Dado que los comentarios no se ejecutan, cuando ejecuta un programa no verá ninguna indicación del comentario en la salida.

Sintaxis:  el símbolo hash (#) indica el comienzo de un comentario en Python.  

# This is a comment in Python

Ejemplo:

# This is the syntax of a comment in Python
print("GFG")
 
# Comments dont have any effect on the interpreter / output

Producción :  

GFG

Los comentarios deben hacerse con la misma sangría que el código sobre el que se comenta.

def GFG():
   
  # Since, this comment is inside a function
  # It would have indent same as the function body
  print("GeeksforGeeks")
   
  for i in range(1, 2):
 
    # Be careful of indentation
    # This comment is inside the body of for loop
    print("Welcome to Comments in Python")
   
# This comment is again outside the body
# of function so it wont have any indent.
 
print("Hello !!")
GFG()

Hello!!
GeeksforGeeks
Welcome to Comments in Python

Tipos de comentarios

1. Comentarios de una sola línea : los comentarios que comienzan con ‘#’ y un espacio en blanco se denominan comentarios de una sola línea en Python. Estos comentarios solo pueden extenderse a una sola línea y son la única forma de comentarios en Python. p.ej

# This a single line comment.

2. Comentarios de varias líneas (bloque) : a diferencia de otros lenguajes de programación, Python no admite bloques de comentarios de varias líneas listos para usar. Sin embargo, podemos usar # comentarios consecutivos de una sola línea para comentar varias líneas de código. Algunos ejemplos de comentarios en bloque-

# This type of comments can serve
# both as a single-line as well
# as multi-line (block) in Python.

3. Comentarios de estilo en línea: los comentarios en línea ocurren en la misma línea de una declaración, siguiendo el código mismo. Generalmente, los comentarios en línea se ven así:

x = 3        # This is called an inline comment

a = b + c    # Adding value of 'b' and 'c' to 'a'

4. Comentarios de strings de documentación: las strings de documentación de Python (o strings de documentación) proporcionan una manera conveniente de asociar documentación con módulos, funciones, clases y métodos de Python. Se especifica en el código fuente que se usa, como un comentario, para documentar un segmento específico de código. A diferencia de los comentarios de código fuente convencionales, la string de documentación debe describir qué hace la función, no cómo.

Ejemplo: 

def my_function():
    """Demonstrates docstrings and does nothing really."""
 
    return None
 
 
print("Using __doc__:")
print(my_function.__doc__)
 
print("Using help:")
help(my_function)

Producción: 

Using __doc__:
Demonstrates docstrings and does nothing really.
Using help:
Help on function my_function in module __main__:

my_function()
    Demonstrates docstrings and does nothing really.

Ventajas y usos de los comentarios:

Planificación y revisión: en los comentarios, podemos escribir el pseudocódigo que planificamos antes de escribir el código fuente. El pseudocódigo es una mezcla de lenguaje natural y lenguaje de programación de alto nivel. Esto ayuda a revisar el código fuente más fácilmente porque el pseudocódigo es más comprensible que el programa. 

Ejemplo:

# This function is adding two given numbers
def addition(a, b):
   
  # storing the sum of given numbers in 'c'.
  c = a + b
   
  # returning the sum here
  return c
 
# passing the value of a and b to addition()
a = 10
b = 3
sum = addition(a, b)
 
# printing the sum calculated by above function
print(sum)

Producción :

13

Depuración : el método de fuerza bruta es un método común de depuración. En este enfoque, se insertan instrucciones de impresión en todo el programa para imprimir los valores intermedios con la esperanza de que algunos de los valores impresos ayuden a identificar los errores. Después de hacer la depuración, comentamos esas declaraciones de impresión. Por lo tanto, el comentario también se usa para la depuración.

a = 12
 
if(a == 12):
  print("True")
   
# elif(a == 0):
  # print("False")
   
else:
  print("Debugging")

 
Producción :

True