Declaración, sangría y comentarios de Python

Declaración, sangría y comentarios de Python

En este tutorial, aprenderá acerca de las declaraciones de Python, por qué la sangría es importante y el uso de comentarios en la programación.

Declaración de Python

Las instrucciones que un intérprete de Python puede ejecutar se denominan declaraciones. Por ejemplo, a = 1 es una instrucción de asignación. if sentencia, for sentencia, while declaración, etc. son otros tipos de declaraciones que se discutirán más adelante.

Declaración de varias líneas

En Python, el final de una declaración se marca con un carácter de nueva línea. Pero podemos hacer que una declaración se extienda por varias líneas con el carácter de continuación de línea (\). Por ejemplo:

a = 1 + 2 + 3 + \
    4 + 5 + 6 + \
    7 + 8 + 9

Esta es una continuación de línea explícita. En Python, la continuación de línea está implícita entre paréntesis ( ) , corchetes [ ] y llaves { } . Por ejemplo, podemos implementar la declaración de varias líneas anterior como:

a = (1 + 2 + 3 +
    4 + 5 + 6 +
    7 + 8 + 9)

Aquí, los paréntesis circundantes ( ) hacer la continuación de línea implícitamente. Lo mismo ocurre con [ ] y { } . Por ejemplo:

colors = ['red',
          'blue',
          'green']

También podemos poner varias declaraciones en una sola línea usando punto y coma, de la siguiente manera:

a = 1; b = 2; c = 3

---

Sangría de Python

La mayoría de los lenguajes de programación como C, C++ y Java usan llaves { } para definir un bloque de código. Python, sin embargo, usa sangría.

Un bloque de código (cuerpo de una función, ciclo, etc.) comienza con sangría y termina con la primera línea sin sangría. La cantidad de sangría depende de usted, pero debe ser consistente a lo largo de ese bloque.

En general, se utilizan cuatro espacios en blanco para la sangría y se prefieren a las pestañas. Aquí hay un ejemplo.

for i in range(1,11):
    print(i)
    if i == 5:
        break

La aplicación de la sangría en Python hace que el código se vea limpio y ordenado. Esto da como resultado programas de Python que se ven similares y consistentes.

La sangría se puede ignorar en la continuación de línea, pero siempre es una buena idea sangrar. Hace que el código sea más legible. Por ejemplo:

if True:
    print('Hello')
    a = 5

y

if True: print('Hello'); a = 5

ambos son válidos y hacen lo mismo, pero el estilo anterior es más claro.

La sangría incorrecta resultará en IndentationError .

---

Comentarios de Python

Los comentarios son muy importantes al escribir un programa. Describen lo que sucede dentro de un programa, de modo que una persona que mira el código fuente no tenga dificultades para descifrarlo.

Es posible que olvide los detalles clave del programa que acaba de escribir en un mes. Así que tomarse el tiempo para explicar estos conceptos en forma de comentarios siempre es fructífero.

En Python, usamos el hash (# ) para comenzar a escribir un comentario.

Se extiende hasta el carácter de nueva línea. Los comentarios son para que los programadores entiendan mejor un programa. El intérprete de Python ignora los comentarios.

#This is a comment
#print out Hello
print('Hello')

---

Comentarios de varias líneas

Podemos tener comentarios que se extiendan hasta varias líneas. Una forma es usar el hash (# ) símbolo al principio de cada línea. Por ejemplo:

#This is a long comment
#and it extends
#to multiple lines

Otra forma de hacer esto es usar comillas triples, ya sea ''' o """ .

Estas comillas triples generalmente se usan para cadenas de varias líneas. Pero también se pueden usar como un comentario de varias líneas. A menos que no sean cadenas de documentación, no generan ningún código adicional.

"""This is also a
perfect example of
multi-line comments"""

Para obtener más información sobre los comentarios, visite Comentarios de Python.

---

Docstrings en Python

Una cadena de documentación es la abreviatura de cadena de documentación.

Las docstrings de Python (cadenas de documentación) son los literales de cadena que aparecen justo después de la definición de una función, método, clase o módulo.

Las comillas triples se utilizan al escribir cadenas de documentación. Por ejemplo:

def double(num):
    """Function to double the value"""
    return 2*num

Las cadenas de documentos aparecen justo después de la definición de una función, clase o módulo. Esto separa las cadenas de documentación de los comentarios de varias líneas mediante comillas triples.

Las cadenas de documentación están asociadas con el objeto como su __doc__ atributo.

Entonces, podemos acceder a las cadenas de documentación de la función anterior con las siguientes líneas de código:

def double(num):
    """Function to double the value"""
    return 2*num
print(double.__doc__)

Salida

Function to double the value

Para obtener más información sobre las cadenas de documentación en Python, visite Cadenas de documentación de Python.