Curso Python - 2.5 Sección 5 - Comentarios

2.
5 Sección 5 – Comentarios
Bienvenido a la Sección 5 donde te compartiremos algunos comentarios sobre comentarios. Aprenderás aquí por qué es
importante documentar tu código y por qué debes dejar comentarios. También aprenderás cómo hacerlo y cuándo los
comentarios se consideran una buena práctica. ¡Veamos!
2.5.1 Comentarios – ¿por qué, cuándo, y

dónde?
Quizá en algún momento será necesario poner algunas palabras en el código dirigidas no a Python,
sino a las personas quienes estén leyendo el código con el fin de explicarles como es que funciona,
o tal vez especificar el significado de las variables, también para documentar quien es el autor del
programa y en que fecha fue escrito.
Un texto insertado en el programa el cual es, omitido en la ejecución, es denominado

un comentario.
¿Cómo se colocan este tipo de comentarios en el código fuente? Tiene que ser hecho de cierta
manera para que Python no intente interpretarlo como parte del código.
Cuando Python se encuentra con un comentario en el programa, el comentario es completamente

transparente - desde el punto de vista de Python, el comentario es solo un espacio vacío, sin
importar que tan largo sea.
En Python, un comentario es un texto que comienza con el símbolo # y se extiende hasta el final de
la línea.
Si se desea colocar un comentario que abarca varias líneas, se debe colocar este símbolo en cada línea.
Justo como en el siguiente código:
Los desarrolladores buenos y responsables describen cada pieza importante de código, por

ejemplo, el explicar el rol de una variables. Aunque la mejor manera de comentar una variable es
dándole un nombre que no sea ambiguo.
Por ejemplo, si una variable determinada esta diseñada para almacenar el área de un cuadrado, el
nombre square_area será muchísimo mejor que aunt_jane.
El nombre dado a la variable se puede definir como auto-comentable.
2.5.2 Marcar fragmentos de código

Los comentarios pueden ser útiles en otro aspecto - se pueden utilizar para marcar un fragmento
de código que actualmente no se necesita, cual sea la razón. Observa el siguiente ejemplo, sí
se descomenta la línea resaltada, esto afectara la salida o resultado del código:
Esto es frecuentemente realizado cuando se esta probando un programa, con el fin de aislar un fragmento de
código donde posiblemente se encuentra un error.
Consejo
Si deseas comentar o descomentar rápidamente varias línea(s) de código, selecciona las líneas que
deseas modificar y utiliza el siguiente método abreviado de teclado: CTRL + / (Windows)
or CMD + / (Mac OS). Es un truco muy útil, ¿no? Ahora experimenta con el código en el editor.
2.5.3 LAB Comentarios
Escenario
El código en el editor contiene comentarios. Intenta mejorarlo: agrega o quita comentarios donde
consideres que sea apropiado (en ocasiones el remover un comentario lo hace mas legible), y
cambia el nombre de las variables donde consideres que esto mejorará la comprensión del código.
Nota
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 mas: puede ocurrir que un comentario contenga una pieza de información incorrecta o
errónea - ¡nunca se debe de hacer eso a propósito!
2.5.4 RESUMEN DE SECCIÓN

1. Los comentarios pueden ser utilizados para colocar información adicional en el código. Son
omitidos al momento de la ejecución. Dicha información es para los lectores que están
manipulando el código. En Python, un comentario es un fragmento de texto que comienza con
un #. El comentario se extiende hasta el final de la línea.
2. Si deseas colocar un comentario que abarque varias líneas, es necesario colocar un # al inicio
de cada línea. Además, se puede utilizar un comentario para marcar un fragmento de código
que no es necesario en el momento y no se desea ejecutar. (observa la última línea de código
del siguiente fragmento), por ejemplo:
3. Cuando sea posible, se deben auto comentar los nombres de las variables, por ejemplo, si
se están utilizando dos variables para almacenar la altura y longitud de algo, los
nombres length y width son una mejor elección que myvar1 y myvar2.
4. Es importante utilizar los comentarios para que los programas sean más fáciles de entender,
además de emplear variables legibles y significativas en el código. Sin embargo, es
igualmente importante no utilizar nombres de variables que sean confusos, o dejar
comentarios que contengan información incorrecta.
5. Los comentarios pueden ser muy útiles cuando tú estás leyendo tu propio código después de
un tiempo (es común que los desarrolladores olviden lo que su propio código hace), y
cuando otros están leyendo tu código (les puede ayudar a comprender que es lo que hacen
tus programas y como es que lo hacen).
2.5.5 CUESTIONARIO DE SECCIÓN

Pregunta 1: ¿Cuál es el resultado del siguiente fragmento?

Curso Python - 2.5 Sección 5 - Comentarios

Cargado por

Copyright:

Formatos disponibles

Curso Python - 2.5 Sección 5 - Comentarios

Cargado por

Información del documento

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Curso Python - 2.5 Sección 5 - Comentarios

Cargado por

Copyright:

Formatos disponibles

2.

2.5.1 Comentarios – ¿por qué, cuándo, y

Un texto insertado en el programa el cual es, omitido en la ejecución, es denominado

Cuando Python se encuentra con un comentario en el programa, el comentario es completamente

Los desarrolladores buenos y responsables describen cada pieza importante de código, por

El nombre dado a la variable se puede definir como auto-comentable.

2.5.2 Marcar fragmentos de código

Es bueno utilizar nombres de variables legibles, y en ocasiones es mejor dividir el código en partes

2.5.4 RESUMEN DE SECCIÓN

2.5.5 CUESTIONARIO DE SECCIÓN

También podría gustarte