Cómo hacer comentarios en Python

En este artículo os vamos a enseñar las distintas maneras que hay en Python de poner comentarios. Como sabéis, los comentarios en programación son esos mensajes que deja el desarrollador para que el código sea mejor comprendido, para si mismo o para terceros, y que no son interpretados por el lenguaje en cuestión, en esta ocasión Python. Los comentarios son muy pero que muy importantes a la hora de programar. Un proyecto bien documentado y con las explicaciones pertinentes es un proyecto de calidad. ¿Por qué? Pues simplemente porque le estamos facilitando el trabajo a los programadores (o a ti mismo) que, pasado un tiempo, tengan que modificar alguna funcionalidad del mismo. No es lo mismo conocer que hace una función o en qué consiste el segundo parámetro que se le pasa a la misma, que este documentado de acuerdo a los códigos de estilo en la zona superior de la función. A continuación vamos a ver 3 diferentes formas de hacer comentarios en Python. ¡Allá vamos!

La primera, y más simple, es la de crear nuestro comentario anteponiéndole el caracter # delante del texto. Es decir, si queremos comentar este texto: "Función que redondea a la alza", tendríamos que ponerlo así: "# Función que redondea a la alza". Aquí un ejemplo de uso de cómo sería un comentario con almohadilla:

# Hola, estoy comentando en Python

La segunda manera de realizar un comentario es, igual que la primera, solo que detrás de una sentencia. A veces necesitamos explicar el uso de líneas de código para una mejor comprensión del código. Aquí entra en juego esta forma de comentar código. El funcionamiento es simple, tras la sentencia añadimos el comentario en cuestión al igual que haríamos en el anterior método. Os pongo un ejemplo:

print "Mostramos esto por pantalla" # y comento la jugada

Si por el contrario deseamos introducir un comentario de varias líneas, necesitaríamos otro método para realizarlo. No es porque con las almohadillas no se pueda, sino porque la manera que te vamos a explicar a continuación es mucho más cómoda de llevar a cabo. Se trata de poner una línea con tres comillas, da igual que sean simples o dobles, después el comentario y, para cerrar, otra línea con tres comillas.

'''
Hola, soy un comentario
con varias líneas
'''

Este último caso no es un comentario en sí. El lenguaje Python solo reconoce como comentarios los textos que estén precedidos del carácter almohadilla. Lo que estamos realizando en este último caso es la creación una cadena de texto multilínea la cual no se asigna a ninguna variable. Al no asignarse a una variable su uso es nulo y podemos utilizarla como vía para arrojar nuestros comentarios.

Y este ha sido el artículo en el que trataba explicaros como hacer comentarios en Python, esperamos que te haya gustado y sepas aplicarlo en tus futuros proyectos. Ya sabes que si nos quieres proponer un tema que quieres ver reflejado como un tutorial o como una práctica, solo tienes que hacer uso del área de comentarios de un poco más abajo. Por el contrario, si quieres enviarnos tus propios tutoriales, puedes hacerlo a través de la intranet de usuarios que está habilitada para ello, a través del menú Enviar Tutorial. Ya sabes, ayúdanos a crecer con tus conocimientos. ¡Un saludo y feliz código!

 

COMPARTE ESTE ARTÍCULO

ENVIAR A UN AMIGO
COMPARTIR EN FACEBOOK
COMPARTIR EN TWITTER
COMPARTIR EN GOOGLE +
ARTÍCULO ANTERIOR

¡SÉ EL PRIMERO EN COMENTAR!
Conéctate o Regístrate para dejar tu comentario.