Tutorial de Python - Declaración y comentario

1. Declaración en Python
2. Indentación de Python
3. Comentarios de Python

En esta sección, se discutirán las declaraciones, indentaciones y comentarios de Python. En la última sesión también se introduce docstring como un tipo especial de comentario en Python.

Declaración en Python

Una declaración Python es una instrucción que se le da al intérprete para que la ejecute. Una sentencia puede contener una expresión como la siguiente

result = x + y

La sentencia Python puede ser considerada como una instrucción al intérprete para resolver la expresión y almacenar su resultado en una variable. Las sentencias como for, while, print tienen un significado especial; estas sentencias se discutirán en una sección posterior.

Sentencias multilínea en Python

Cuando se pulsa la tecla Intro después de una expresión, esa expresión en particular se termina y es una expresión de una línea. Una sentencia de varias líneas puede ser creada en Python usando el carácter de continuación de línea \ que extenderá la sentencia de Python a varias líneas.

Considere el código que se muestra a continuación:

x = 100 + 101 + 102 + 103 + 104 + 105

Esto se llama continuación de línea explícita.

También puede hacer continuación de línea implícita usando el paréntesis (), los corchetes [] o las llaves {}.

Por ejemplo, puede escribir encima de un enunciado de línea múltiple usando el paréntesis as:

x = 100 + 101 + 102 + 103 + 104 + 105

Indentación de Python

El bloque de sentencias, por ejemplo, el cuerpo de una función o un bucle o una clase, comienza con la indentación. La indentación debe ser la misma para cada declaración dentro del bloque. Obtendrás un Error de indentación cuando la indentación sea incorrecta.

Normalmente, 4 espacios para la indentación como se aconseja en Guía de estilo para el código Python. Considera el ejemplo siguiente:

x = {1, 2, 3, 4}
for i in x:
    print(i)

La indentación se usa básicamente para crear programas más legibles.

En el siguiente ejemplo, el mismo código se escribe de dos maneras diferentes:

x = {1, 2, 3, 4}
for i in x:
    print(i)

for i in x:
    print(i)

Puedes ver aquí que el primer ejemplo tiene una mejor legibilidad que el segundo.

Comentarios de Python

Los comentarios se utilizan para describir el propósito o el funcionamiento de un programa. Los comentarios son las líneas ignoradas por Python durante la interpretación y no perturban el flujo de un programa.

Si está escribiendo un código de cientos de líneas, debería añadir comentarios ya que otros usuarios no tienen suficiente tiempo para leer cada línea para entender el funcionamiento del código. De esta manera, los comentarios aumentan la legibilidad y explican cómo funciona el código también.

Un comentario en Python comienza con el símbolo de hash #.

# Single Line comment
# Program to print a string
print("Hello Python Programmer")

Comentarios multilínea en Python

Usando el símbolo hash en cada línea se puede definir un comentario multilínea. Pero hay otra forma de añadir un comentario multilínea en Python, que es usando comillas triples. Puede usar ''' o """.

"""Multi-line
comments in 
Python Programming language"""

Las comillas triples se usan en realidad para definir una cadena de documentación multilínea, pero también puede usarlas como comentarios multilínea.

Cadena de documentación en Python

Docstring es la cadena de documentación que es la primera sentencia en una función, clase, módulo, etc. de Python. La descripción y los comentarios de las funciones, métodos y clases están dentro de una docstring (cadena de documentación).

Considere el ejemplo siguiente:

def sum(a, b):
    """This function adds two values"""
    return a + b

Puede ver aquí que la cadena de documentación dice lo que hace la función.