11 - Definición de comentarios en el código fuente

Un programa en Python puede definir además del algoritmo propiamente dicho una serie de comentarios en el código fuente que sirvan para aclarar los objetivos de ciertas partes del programa.

Tengamos en cuenta que un programa puede requerir mantenimiento del mismo en el futuro. Cuando hay que implementar cambios es bueno encontrar en el programa comentarios sobre el objetivo de las distintas partes del algoritmo, sobretodo si es complejo.

Existen dos formas de definir comentarios en Python:

  • Comentarios de una sola línea, se emplea el caracter #:
    #definimos tres contadores
    conta1=0
    conta2=0
    conta3=0
    

    Todo lo que disponemos después del caracter # no se ejecuta

  • Comentarios de varias líneas:

    """Definimos tres contadores
       que se muestran si son distintos a cero"""
    conta1=0
    conta2=0
    conta3=0
    

    Se deben utilizar tres comillas simples o dobles seguidas al principio y al final del comentario.

Problema 1:

Mostrar la tabla de multiplicar del 5 empleando primero el while y seguidamente de nuevo empleando el for.

Programa: ejercicio55.py

"""
Mostrar la tabla de 5 con las estructuras repetitivas:
  while
  y
  for
"""

#utilizando el while
print("Tabla del 5 empleando el while")
x=5
while x<=50:
    print(x)
    x=x+5

#utilizando el for
print("Tabla del 5 empleando el for")
for x in range(5,51,5):
    print(x)    

Problemas propuestos

  • Realizar un programa que solicite la carga de valores enteros por teclado y los sume. Finalizar la carga al ingresar el valor -1. Dejar como comentario dentro del código fuente el enunciado del problema.
  • Confeccionar un programa que solicite la carga de 10 valores reales por teclado. Mostrar al final su suma. Definir varias líneas de comentarios indicando el nombre del programa, el programador y la fecha de la última modificación. Utilizar el caracter # para los comentarios.
Solución
ejercicio56.py

"""
Realizar un programa que solicite la carga de valores enteros por teclado y los sume.
Finalizar la carga al ingresar el valor -1.
"""

suma=0
valor=int(input("Ingrese valor (-1 finaliza):"))     # se carga el primer valor antes del while
while valor!=-1:
    suma=suma+valor
    valor=int(input("Ingrese valor(-1 finaliza):"))  # se cargar todos los otros valores dentro del while
print("La suma de los valores ingresados es")
print(suma)




ejercicio57.py

#Programa: Carga de 10 Numeros
#Programador: Paz Marcos
#Fecha de última modificación: 28/06/2018

suma=0.0
for x in range(10):
    valor=float(input("Ingrese valor:"))
    suma=suma+valor
print("La suma de los 10 numeros es")
print(suma)