Al escribir código Python, siempre es una buena práctica hacer que su código sea limpio y fácilmente comprensible. Organizar el código, dar nombres descriptivos a las variables y funciones son varias formas de hacerlo.

Otra forma de mejorar la legibilidad de su código es usar comentarios. Un comentario es una explicación o anotación legible por humanos que se utiliza para explicar el código. Por ejemplo, si escribió una expresión regular compleja, agregue un comentario que describa lo que hace el código.

Agregar comentarios a su código de Python le ahorrará mucho tiempo y esfuerzo cuando mire su código en el futuro. Supongamos que desea cambiar un guión que escribió hace unos meses o años. Lo más probable es que no recuerde por qué escribió un código complicado a menos que agregue un comentario. Los comentarios también ayudan a otros desarrolladores a comprender su código y su propósito.

Los comentarios deben ser breves y directos. No explique algo que es obvio para el lector.

Este artículo cubre los conceptos básicos para escribir comentarios en Python.

Escribir comentarios en Python

Python ignora todo lo escrito en la línea después de la marca hash ( #).

Los comentarios se pueden agregar al principio de la línea o en línea con otro código:

# This is a Python comment.
print("Hello World") # This is an inline Python comment.

El espacio en blanco después de la almohadilla no es obligatorio, pero mejorará la legibilidad del comentario.

Un carácter hash dentro de un literal de cadena no indica el comienzo de una línea de comentario. Es simplemente un carácter hash:

paragraph = "# Hash inside quotes is not a comment."

Comments should be at the same indent level as the code beneath it:

```py
def factorial(n):
  if n == 0:
    return 1
  else:
    # Use the factorial function
    return n * factorial(n-1)

Si su editor de texto admite el resaltado de sintaxis, los comentarios generalmente se representan en verde.

Los comentarios también son útiles al depurar un script. En lugar de eliminar algunas líneas o bloques, puede comentarlos:

# for fruit in fruits:
#   print(fruit)

Comentarios multilínea en Python (Bloques de comentarios)

A diferencia de otros lenguajes de programación populares, Python solo admite comentarios de una sola línea.

La forma más sencilla de escribir comentarios de varias líneas en Python es agregar comentarios de una sola línea uno tras otro:

# This is the first line.
# This is the second line.

Otra opción es usar docstrings .

Las cadenas de documentos son literales de cadenas de varias líneas que se utilizan para documentar lo que hace un módulo, una función, una clase o un método.

Una cadena de documentación comienza y termina con comillas dobles triples ( """) y puede abarcar una o varias líneas:

"""This is
a multiline
docstring.
"""

Los docstrings no son técnicamente comentarios. Cuando una cadena de documentos aparece como la primera declaración en un módulo, función, clase o método, termina en el código de bytes y se convierte en el __doc__atributo especial de ese objeto. Debería preferir usar comentarios hash regulares de una sola línea.

El asunto

Si está leyendo scripts de Python, puede notar que en algunos de ellos la primera línea comienza con los #!caracteres y la ruta al intérprete de Python:

#!/usr/bin/env python3

Esta secuencia de caracteres se llama shebang y se usa para decirle al sistema operativo qué intérprete usar para analizar el resto del archivo. Los scripts que comienzan con shebang y son ejecutables se pueden ejecutar en la terminal sin escribir pythonantes del nombre del script.

Debido a que la línea shebang comienza con el carácter hash, se considera un comentario y el intérprete de Python la ignora automáticamente.

Conclusión

Escribir comentarios es una buena práctica y ayuda a otros desarrolladores, incluido uno mismo en el futuro, a comprender lo que hace el código. En Python, todo lo que sigue a la almohadilla ( #) y hasta el final de la línea se considera un comentario.

Si tiene alguna pregunta o comentario, no dude en dejar un comentario.