Comentarios

Añadir comentarios

A veces nos encontramos con programas escritos por otras personas, y cuya complejidad dificulta el examen del programa. Otras veces se trata de trabajos realizados por nosotros mismos hace ya tiempo, y no resulta fácil recordar el propósito original.

Para facilitar la revisión de un programa, conviene añadir anotaciones explicando lo que tratamos de hacer:

# Programa para demostrar el uso
# de operaciones de cálculo

print( 15 + 3 )   # suma
print( 15 - 3 )   # resta
print( 15 * 3 )   # multiplicación
print( 15 / 3 )   # división

Cuando Python encuentra un token que empieza o consiste en un símbolo "#", todo lo que viene a continuación, hasta el final de la línea, será ignorado al ejecutar el programa. A esto se le denomina "comentarios".

Los comentarios pueden ocupar toda una línea del texto, o acompañar a una sentencia. Lo que hay a la izquierda del símbolo "#" se considera como sentencia a ejecutar. Lo que hay a la derecha, se ignorará.

Bloques de comentarios

Si tenemos un bloque de comentarios muy grande, marcar todas las líneas una a una puede resultar un poco "pesado". En lenguaje Python hay un truco para evitarlo. Consiste en delimitar entre triples comillas el bloque de texto a ignorar:

"""
Programa para demostrar el uso
de operaciones de cálculo
"""

print( 15 + 3 )   # suma
print( 15 - 3 )   # resta
print( 15 * 3 )   # multiplicación
print( 15 / 3 )   # división

También valen los apóstrofos:

'''
Programa para demostrar el uso
de operaciones de cálculo
'''

print( 15 + 3 )   # suma
print( 15 - 3 )   # resta
print( 15 * 3 )   # multiplicación
print( 15 / 3 )   # división

¿Comillas o apóstrofos?

En lenguaje Python, las comillas y apóstrofos se usan para delimitar texto, en este caso, comentarios. Ambas opciones son válidas, pero si comenzamos con comillas, hay que finalizar con comillas. Si comenzamos con apóstrofos, hay que finalizar con apóstrofos.

A tener en cuenta:

• No debemos confundir el carácter de apóstrofo ' con el de acento ´ ni con el de acento invertido `. Examinemos el teclado para localizar cada uno de ellos.

• No confundir el término apóstrofo con apóstrofe, que es una figura literaria.

• En la literatura informática, es frecuente referirse a los apóstrofos como comillas simples, en oposición a las comillas ordinarias, o comillas dobles.

Comentar sentencias

Además de su propósito de documentación, los comentarios tienen otro uso especial. Sirven para anular sentencias que no queremos ejecutar, pero tampoco borrarlas del programa.

Es algo típico, por ejemplo, en situaciones donde lo que queremos es añadir alguna instrucción "de pruebas" para verificar que el programa funciona bien. Cuando completamos la fase de pruebas, podemos quitar esas sentencias, o dejarlas como comentarios.

# Programa para demostrar el uso
# de operaciones de cálculo

print( 15 + 3 )
print( 15 * 3 )

# print( 15 - 3 )
# print( 15 / 3 )

Si en el futuro necesitamos revisar el programa, podemos quitar ese símbolo # y seguir haciendo pruebas.

A esto se le llama comentar instrucciones, y cuando quitamos el símbolo #, las estamos descomentando.

IDLE cuenta con una ayuda para comentar un bloque de sentencias:

• seleccionar el texto a comentar
• pulsar en el menú Format >> Comment
• automáticamente, se añadirá un carácter # a todas las líneas del texto seleccionado.

También tenemos la operación inversa, el menú Format >> Uncomment