LABORATORIO - Comentarios

Tiempo Estimado

5 minutos

Nivel de Dificultad

Muy fácil

Objetivos

  • Familiarizarse con el concepto de comentarios en Python.
  • Utilizar y no utilizar los comentarios.
  • Reemplazar los comentarios con código.
  • Experimentar con el código de Python.

Escenario

Tenemos el siguiente programa:

h = 2 
s = 3600 
print("Horas: ", h) 
print("Segundos en Horas: ", h * s) 

Añade comentarios para que el código sea más legible. Cambia el nombre de las variables para que mejoren la claridad del código. El programa calcula el número de segundos de las horas que tenemos guardada en la variable h. En la variable s guardamos el total de segundos de una hora.

Ten en cuenta los siguiente:

Los comentarios son muy importantes. No solo hacen que el programa sea más fácil de entender, pero también sirven para deshabilitar aquellas partes de código que no son necesarias (por ejemplo, cuando se necesita probar cierta parte del código, e ignorar el resto). Los buenos programadores describen cada parte importante del código, y dan nombres significativos a variables, debido a que en ocasiones es mucho más sencillo dejar el comentario dentro del código mismo.

Es bueno utilizar nombres de variables legibles, y en ocasiones es mejor dividir el código en partes con nombres (por ejemplo en funciones). En algunas situaciones, es una buena idea escribir los pasos de como se realizaron los cálculos de una forma sencilla y clara.

Una cosa más: puede ocurrir que un comentario contenga una pieza de información incorrecta o errónea, nunca se debe de hacer eso a propósito.