Saltar al contenido

Cómo usar comentarios en Python

Cuando trabaja con cualquier lenguaje de programación, incluye comentarios en el código para anotar su trabajo. Esto detalla para qué sirven ciertas partes del código y permite a otros desarrolladores, incluido usted, saber qué estaba haciendo cuando escribió el código. Esta es una práctica necesaria y los buenos desarrolladores hacen un uso intensivo del sistema de comentarios. Sin él, las cosas pueden volverse realmente confusas, muy rápido.

Cómo escribir comentarios en Python

En Python, hay dos formas de anotar su código.

La primera es incluir comentarios que detallen o indiquen qué hace una sección de código, o fragmento.

El segundo hace uso de comentarios o párrafos de varias líneas que sirven como documentación para que otros lean su código.

Piense en el primer tipo como un comentario para usted y el segundo como un comentario para otros. Sin embargo, no existe una forma correcta o incorrecta de agregar un comentario. Puedes hacer lo que te resulte cómodo.

Los comentarios de una sola línea se crean simplemente comenzando una línea con el carácter de almohadilla (#) y se terminan automáticamente al final de la línea.

Por ejemplo:


#This would be a comment in Python

Los comentarios que abarcan varias líneas, que se utilizan para explicar las cosas con más detalle, se crean agregando un delimitador (“” ”) en cada extremo del comentario.


""" 
This would be a multiline comment
in Python that spans several lines and
describes your code, your day, or anything you want it to
""" 

Tenga en cuenta: El método recomendado para comentar varias líneas es usar # en cada línea. El método (“” ”) no es en realidad un comentario, sino que define una constante Text del texto entre (“ ””). No se muestra, pero existe y podría causar errores inesperados.

Recuerde comentar con la mayor frecuencia posible. ¡Es importante!

Entrenamiento de Python recomendado

Para el entrenamiento de Python, nuestra principal recomendación es DataCamp.