Tipos de comentarios
Existen varias maneras de escribir (sintaxis) un comentario para agregarlo a un programa en Python:
1. Comentario de una sola línea
Todo lo que esté escrito en una sola línea después del # se considera un comentario.
La sintaxis para escribir comentarios de una sola línea es:
Si utilizas Visual Studio Code para programar, el atajo (shortcut) para convertir una o varias líneas de código en un comentario es
CTRL + K + C.
2. Comentario a continuación de una instrucción de código
¡Para recordar!
Cuando se inicia un comentario, este se extenderá hasta el final de la línea de código, impidiendo que pueda haber mas código ejecutable a continuación de este, en la línea afectada.
También puedes utilizar cadenas literales pero sin asignarlas a ninguna variable. Por lo tanto, si no se asigna una cadena literal a una variable, el intérprete de Python la ignorará cuando la lea durante la ejecución del programa. Una cadena literal es definida encerrando su contenido entre comillas simples (') o comillas dobles (") de manera indistinta siempre y cuando no mezcles los tipos de comillas para definir la cadena.
¡Buena práctica!
Se recomienda utilizar menos de 79 caracteres en un comentario de una sola línea para que sea más fácil de leer. Si el comentario excede la longitud recomendada, se debe utilizar un bloque de comentarios de varias líneas.
3. Comentario en bloque de varias líneas
Python no admite comentarios de varias líneas. Sin embargo, existen varias maneras de superar este problema y, aunque ninguna de estas maneras son técnicamente comentarios de varias líneas, puedes usarlas como si lo fueran.
# Puedes utilizar
# múltiples líneas de comentarios
# de esta manera
# incluyendo el símbolo de comentario
# al principio de cada línea
La primera manera es utilizar
#al principio de cada línea de comentario.
La segunda manera es utilizar cadenas de varias líneas para comentar. Para hacer esto, debes usar las comillas simples (') o las comillas dobles (") tres veces.
Existe una cuarta manera de comentar denominada cadena de documentación (docstrings). Esta es una cadena literal que se utiliza para documentar funciones, métodos, clases y módulos. Aunque no es un comentario en sí mismo, se utiliza para documentar el código y proporcionar información sobre su funcionamiento.
La estudiamos en detalle en la siguiente sección.