Cada lenguaje de programación proporciona un mecanismo para agregar comentarios a los proyectos. Los comentarios son líneas simples en programas de computadora que son ignoradas por el compilador o el intérprete. Los comentarios a menudo se escriben en lenguaje natural para aumentar la comprensión del programador. Los desarrolladores usan comentarios para ignorar algunas partes del código en la fase de depuración o prueba.
Escribir comentarios en Python puede ser muy simple, y crear un comentario en Python comienza con el símbolo '#'. Este artículo explica cómo crear comentarios de varias líneas en Python.
Escribir comentarios de varias líneas en Python
A diferencia de muchos otros lenguajes de programación, Python no proporciona ninguna forma específica de escribir comentarios de varias líneas. No obstante, existen otras formas de afrontar este problema.
En Java, escribimos varios comentarios de la siguiente manera:
/*
Arriba, estamos escribiendo un comentario de varias líneas.
Este formato de comentario no funciona en Python.
*/
El método anterior para escribir comentarios tampoco funciona en Python.
Veamos otras formas de escribir comentarios de varias líneas en Python.
Uso de varios comentarios de línea de símbolo
El símbolo '#' se utiliza para escribir el comentario de una sola línea de Python. Con varios comentarios consecutivos de una sola línea, podemos escribir comentarios de varias líneas. Veamos un ejemplo de esto.
#Hola, todos
#esto es un comentario en Python
#Estoy escribiendo comentarios de varias líneas
#utilizando el comentario de una sola línea
Esta es una forma de escribir comentarios de varias líneas. Es un proceso un poco lento, ya que requiere que escribamos varios comentarios de una sola línea.
Ahora, veamos otras formas de escribir comentarios de varias líneas en Python.
Uso de literales de cadena para escribir comentarios de varias líneas
Como se mencionó anteriormente, Python no proporciona una forma real de escribir comentarios de varias líneas, pero pueden utilice cadenas literales para escribir comentarios de varias líneas. El intérprete de Python pasa por alto las cadenas literales no asignadas a ninguna variable y no las ejecuta. Por lo tanto, puede usar literales de cadena no asignados para escribir comentarios de varias líneas en Python. Veamos un ejemplo de esto.
'Estamos usando el literal de cadena como comentario''Este es un comentario de varias líneas'
'Estamos imprimiendo el programa hola mundo'
print ('Hola mundo')
Producción
En el resultado, puede ver que el intérprete de Python no genera ningún error e imprime el mensaje 'Hola mundo'.
Uso de literales de cadena entre comillas triples para escribir comentarios de varias líneas
Aunque los literales de cadena entre comillas triples se utilizan principalmente para escribir cadenas de documentos, también puede utilizar esta herramienta para escribir comentarios de varias líneas. Asegúrese de no confundir la cadena de documentos con los literales de cadena entre comillas triples que se utilizan para escribir comentarios de varias líneas. La sangría incorrecta de literales de cadena entre comillas triples generará un error. Veamos un ejemplo de esto.
'''Estamos usando los literales de cadena entre comillas triples para comentarios de varias líneas
El lenguaje de programación es Python
Imprimamos el hola mundo
'''
print ('Hola mundo')
Producción
En el resultado, puede ver que el intérprete de Python no genera ningún error e imprime el mensaje 'Hola mundo'.
Ahora, usemos los literales de cadena entre comillas triples dentro de una función para escribir comentarios de varias líneas.
En el ejemplo dado, estamos imprimiendo la suma de dos números.
def cal_sum ():'''
estamos calculando la suma de dos números.
Este es el programa de suma
'''
num1 = 10
num2 = 20
print ('La suma es:', num1 + num2)
'''
Función principal de Python
'''
def principal ():
cal_sum ()
if __name__ == '__main__':
principal()
Producción
Ahora, cambiemos la sangría y en la salida, verá que el intérprete genera un error.
def cal_sum ():'''
Estamos calculando la suma de los dos números.
Este es el programa de suma
'''
num1 = 10
num2 = 20
print ('La suma es:', num1 + num2)
'''
Función principal de Python
'''
def main ():
cal_sum ()
if __name__ == '__main__':
principal()
Producción
El intérprete genera el error de sangría.
Conclusión
Este artículo explica cómo crear comentarios de varias líneas en el lenguaje de programación Python. Aunque Python no proporciona ninguna forma real de escribir comentarios de varias líneas, puede abordar este problema utilizando los diversos métodos que se describen en este artículo.