Comentarios

Tipos de comentarios

 A medida que los programas que escribas se vuelvan más largos y complejos, llevará más tiempo terminar los proyectos de programación en python. Por eso es importante que tu y otros puedan fácilmente entender cualquier código que se encuentren en el futuro. Las herramientas que nos permiten hacer esto en Python son los comentarios.

En python hay dos tipos de comentarios. Comentarios de una sola línea y comentarios que abarcan varias líneas.

Para crear un comentario de sola línea, comienza con el carácter # seguido con tu comentario o comienza y termina con una triple comilla “”” para crear un comentario en varias líneas. A continuación hay ejemplos sobre cómo crear estos comentarios.

Las diferentes formas de crear comentarios en python:

#Este es un comentario de sola linea.

print (“Hola Mundo”) #aquí comienza un comentario en linea

“””  Hola este es un comentario de varias lineas.

Los programas que tienen varios archivos y

fueron creados por varias personas generalmente 

tienen un comentario de varias líneas al principio.

Esto le dice a los otros programadores quien escribió

ese programa y lo que está haciendo. “””

En comentarios de Python todo después de el carácter # es ignorado hasta el final de la línea. Comentarios puden seguir otro código. En muchos casos comentarios se usan para explicar lo que está sucediendo en el código.

Un proyecto que usa comentarios correctamente:

#Nombre: Alex Garza

#Clase: Ciencias de la Computación 1

#Fecha: 4/6/2019

“””Resumen: La transposición de una matriz

es el intercambio de filas y columnas. 

En este programa denotamos la matriz  

A. El elemento en la fila j y columna 

k en A se colocará en la fila k y 

columna j en A’. Entonces, si A es una

matriz de 3×2, A’será una matriz de 2×3.”””

A = [[23,12],[4 ,15],[6 ,8]]

resultado = [[0,0,0],[0,0,0]]


for j in range(len(A)):             #iterar a través de filas

    for k in range(len(A[0])):   #iterar a través de columnas

        resultado[k][j] = A[j][k] # la transposición se agrega

        for r in resultado:            #muestra el resultado

            print(r)

En este programa implementamos un matriz  como una lista anidada. Tratamos cada elemento como una fila de la matriz y monstramos el resultado de cada transposición.

Se puede ver cómo comentamos este programa para que sea más fácil de leer para otros. Primero hicimos un comentario para mostrar quién es el autor, cuándo fue escrito y para qué clase fue escrito.

También escribimos un resumen para que quien lo lea sepa lo que está haciendo el programa, así como un comentario en cada paso importante del programa.

¿Por qué son importantes los comentarios?

Al trabajar en un proyecto más grande, se espera que todos contribuyan a diferentes partes del proyecto. Por lo tanto, es importante que sus socios no solo puedan descubrir en qué partes ha trabajado, sino también cómo pueden conectar su código al suyo de la manera más eficiente posible. En muchos casos, es fácil saber qué hace un programa con un vistazo rápido a las definiciones de variables y funciones.

Pero una vez que los programas tienen miles de líneas, es más fácil para ellos hacer referencia a un método que ha escrito al tener comentarios en línea. Los comentarios en línea deben usarse con moderación para aclarar fragmentos de código que no son evidentes por sí solos. Esto los ayudaría enormemente a prevenir futuros dolores de cabeza.