Declaración, sangría y comentario en Python

Declaraciones

Las instrucciones escritas en el código fuente para su ejecución se denominan sentencias. Hay diferentes tipos de declaraciones en el lenguaje de programación Python, como declaraciones de asignación, declaraciones condicionales, declaraciones de bucle, etc. Todas ayudan al usuario a obtener el resultado requerido. Por ejemplo, n = 50 es una instrucción de asignación.

Declaraciones de varias líneas: las declaraciones en Python se pueden extender a una o más líneas usando paréntesis(), llaves {}, corchetes [], punto y coma (;), barra oblicua de carácter de continuación (\). Cuando el programador necesita hacer cálculos largos y no puede encajar sus declaraciones en una línea, puede hacer uso de estos caracteres. 

Ejemplo: 

Declared using Continuation Character (\):
s = 1 + 2 + 3 + \
    4 + 5 + 6 + \
    7 + 8 + 9

Declared using parentheses () :
n = (1 * 2 * 3 + 7 + 8 + 9)

Declared using square brackets [] :
footballer = ['MESSI',
          'NEYMAR',
          'SUAREZ']

Declared using braces {} :
x = {1 + 2 + 3 + 4 + 5 + 6 +
     7 + 8 + 9}

Declared using semicolons(;) :
flag = 2; ropes = 3; pole = 4

Sangría

Un bloque es una combinación de todas estas declaraciones. El bloque puede considerarse como la agrupación de declaraciones para un propósito específico. La mayoría de los lenguajes de programación como C, C++ y Java usan llaves { } para definir un bloque de código. Una de las características distintivas de Python es el uso de sangría para resaltar los bloques de código. Los espacios en blanco se utilizan para la sangría en Python. Todas las declaraciones con la misma distancia a la derecha pertenecen al mismo bloque de código. Si un bloque tiene que anidarse más profundamente, simplemente se sangra más a la derecha. 

Uno puede entenderlo mejor mirando las siguientes líneas de código: 

# Python program showing
# indentation
 
site = 'gfg'
 
if site == 'gfg':
    print('Logging on to geeksforgeeks...')
else:
    print('retype the URL.')
print('All set !')

Logging on to geeksforgeeks...
All set !

Las líneas print(‘Iniciando sesión en geeksforgeeks…’) e print(‘Vuelva a escribir la URL.’) son dos bloques de código separados. Los dos bloques de código en nuestro ejemplo de sentencia if tienen sangría de cuatro espacios. La impresión final (‘¡Todo listo!’) no tiene sangría, por lo que no pertenece al bloque else. 

j = 1
while(j<= 5):
     print(j)
     j = j + 1

1
2
3
4
5

Para indicar un bloque de código en Python, debe sangrar cada línea del bloque con el mismo espacio en blanco. Las dos líneas de código en el ciclo while tienen sangría de cuatro espacios. Es necesario para indicar a qué bloque de código pertenece una sentencia. Por ejemplo, j=1 y while(j<=5): no tiene sangría, por lo que no está dentro del bloque while. Entonces, el código de Python se estructura por sangría.

Comentarios

Los desarrolladores de Python a menudo hacen uso del sistema de comentarios ya que, sin él, las cosas pueden volverse muy confusas, muy rápido. Los comentarios son la información útil que los desarrolladores proporcionan para que el lector entienda el código fuente. Explica la lógica o una parte de ella utilizada en el código. Los comentarios suelen ser útiles para alguien que mantiene o mejora su código cuando ya no está disponible para responder preguntas al respecto. Estos se citan a menudo como una convención de programación útil que no forma parte de la salida del programa pero mejora la legibilidad de todo el programa. Hay dos tipos de comentarios en Python: 

Comentarios de una sola línea: los comentarios de una sola línea de Python comienzan con un símbolo de hashtag sin espacios en blanco (#) y duran hasta el final de la línea. Si el comentario excede una línea, coloque un hashtag en la siguiente línea y continúe con el comentario. Se ha demostrado que los comentarios de una sola línea de Python son útiles para proporcionar explicaciones breves de variables, declaraciones de funciones y expresiones. Consulte el siguiente fragmento de código que muestra un comentario de una sola línea:

Código 1: 

# This is a comment
# Print “GeeksforGeeks !” to console
print("GeeksforGeeks")

GeeksforGeeks

Código 2: 
 

a, b = 1, 3 # Declaring two integers
sum = a + b # adding two integers
print(sum) # displaying the output

String de varias líneas como comentario: el comentario de varias líneas de Python es un fragmento de texto encerrado en un delimitador («»») en cada extremo del comentario. Nuevamente, no debe haber espacios en blanco entre el delimitador («»»). Son útiles cuando el texto del comentario no cabe en una sola línea; por lo tanto, es necesario abarcar líneas. Los comentarios o párrafos de varias líneas sirven como documentación para otras personas que leen su código. Consulte el siguiente fragmento de código que muestra un comentario de varias líneas:

Código 1: 

"""
This would be a multiline comment in Python that
spans several lines and describes geeksforgeeks.
A Computer Science portal for geeks. It contains
well written, well thought
and well-explained computer science
and programming articles,
quizzes and more.
…
"""
print("GeeksForGeeks")

GeeksForGeeks

Código 2:

'''This article on geeksforgeeks gives you a
perfect example of
multi-line comments'''
 
print("GeeksForGeeks")

GeeksForGeeks

Docstrings: Docstrings son un tipo de comentario que se utiliza para mostrar cómo funciona el programa. Las strings de documentación están rodeadas por comillas triples («»» «»»). El intérprete también descuida las strings de documentación.

# program illustrates the use of docstrings
 
def helloWorld():
  """ This program prints out hello world """ #This is a docstring comment
  print("Hello World")
   
helloWorld()

Hello World

Diferencia entre ‘Docstrings’ y ‘Comentarios de varias líneas’ de la siguiente manera: 

Nota: las strings de documentación y los comentarios de varias líneas pueden tener el mismo aspecto, pero no lo son.

• Las strings de documentos se escriben en las funciones y clases para mostrar cómo usar el programa.
• Los comentarios de varias líneas se utilizan para mostrar cómo funciona un bloque de código.