programacion-comentarios

Qué son los comentarios en el código

Los comentarios son fragmentos de texto que se incluyen en el código fuente de un programa, pero que no se ejecutan ni afectan al funcionamiento del programa en sí.

Su principal propósito es proporcionar explicaciones, aclaraciones o anotaciones sobre el código escrito, facilitando la comprensión tanto para el programador original como para otros desarrolladores que puedan leer o modificar el código en el futuro.

Los comentarios son ignorados por el compilador o intérprete, por lo que no tienen ningún efecto en la ejecución del programa.

Casi todos los lenguajes incorporan la posibilidad de añadir comentarios al código. Son una herramienta que permite a los desarrolladores comunicarse con otros programadores y dejar notas explicativas dentro del código fuente.

Los comentarios proporcionan información adicional sobre el funcionamiento de un programa y ayudan a comprender mejor su lógica y estructura.

Existen dos tipos principales de comentarios en programación: los comentarios de una sola línea y los comentarios de bloque.

Comentarios de una sola línea

Los comentarios de una línea son aquellos que se utilizan para añadir notas breves o aclaraciones en una sola línea de código.

En la mayoría de los lenguajes de programación, se utilizan caracteres especiales para indicar el inicio de un comentario de una línea.

Es muy frecuente emplear una doble barra // en lenguajes herederos de C, como C++, Java o C#

// esto es un comentario de una línea

int miVariable = 25;  // también se puede poner al final

Pero no es el único caso. Por ejemplo, en Python se usa #

# esto es un comentario de una línea

miVariable = 25  # también se puede poner al final

Mientras que SQL o VB usan el separador '

'  esto es un comentario de una línea

Dim miVariable = 25   'también se puede poner al final

Comentarios multilínea

Los comentarios de múltiples líneas se utilizan cuando es necesario añadir explicaciones más extensas o comentarios que abarcan varias líneas de código.

En la mayoría de los lenguajes de programación, los comentarios de múltiples líneas se encierran entre un delimitador de inicio y un delimitador de fin.

En los lenguajes derivados de C se emplea /* y */

/*
Este es un comentario
de múltiples líneas en
Se utiliza para proporcionar
explicaciones más extensas
*/
int miVariable = 25;

Pero, nuevamente, no es la única opción posible. Python, por ejemplo, emplea ''' tanto como indicador de inicio o final de un comentario de bloque

'''
Este es un comentario
de múltiples líneas
Se utiliza para proporcionar
explicaciones más extensas
'''
miVariable = 25

Por otro lado, no todos los lenguajes tienen comentarios multilínea. En este caso, simplemente comentamos todas las líneas que queramos. Por ejemplo, en VB

'  Este es un comentario
'  de múltiples líneas
'  Se utiliza para proporcionar
'  explicaciones más extensas
Dim miVariable = 25

Buenas prácticas en el uso de comentarios

Si bien los comentarios son una herramienta muy útil para hacer que el código sea más fácil de entender, es importante no abusar de ellos.

Los comentarios pueden llegar a ser un problema si se utilizan en exceso o si se utilizan de manera incorrecta.

  • Usa comentarios para explicar el porqué del código, no el cómo. El código debe ser lo suficientemente claro para explicar cómo funciona, sin necesidad de comentarios adicionales.
  • Usa comentarios para explicar partes del código que sean difíciles de entender o que tengan una complejidad significativa.
  • Asegúrate de que los comentarios sean precisos y estén actualizados. Si cambias el código, asegúrate de actualizar también los comentarios.
  • Evita comentar el código que ya es obvio. Los comentarios deben proporcionar información adicional, no repetir lo que ya se puede ver en el código. Es decir, no hagas esto:
int miVariable = 25; // asigno 25 a miVariable
  • No uses comentarios para desactivar código. Si tienes código que no funciona correctamente, es mejor eliminarlo o comentarlo temporalmente para poder arreglarlo en el futuro.