C# / Comentarios

Bienvenidos sean a este post, hoy hablaremos sobre un tema que tiene varias utilidades, la mas importante o para la que fue creada es justamente para la que menos se usa y en cambio si se usa para otra actividad pero antes leamos la siguiente frase informatica.

Comentar el código es como limpiar el cuarto de baño; nadie quiere hacerlo, pero el resultado es siempre una experiencia más agradable para uno mismo y sus invitados

Ryan Campbell

Esto es una gran verdad porque el comentar nuestros codigos nos permite saber que hace cada parte del programa, nos puede suceder dos cosas cuando estamos con un codigo:

• El programa que iniciamos lo tenga que continuar otra persona
• Retomar un codigo despues de muchos meses

En el primer caso puede suceder que estemos trabajando en un grupo y nos reasignen a otro proyecto y nuestra tarea deba ser seguida por otra persona, el segundo es el mas habitual ya que puede suceder que estemos en un proyecto propio, lo dejemos por un tema X y cuando volvemos a retormarlo no nos acordemos de nada, para evitar estos inconvenientes podemos usar los comentarios.

Los comentarios se dividen principalmente en dos partes, los de linea simple o los multi lineas, veamos el primer caso:

// Esto es un comentario.

Siempre van a ser de doble barra y luego todo el texto que siga va a ser el comentario, este tipo de comentario es ignorado por el lenguaje ya que lo considera como un mensaje descriptivo, no debe terminar con punto y coma (;) y esto como lo dijimos solo se aplica a la linea donde lo usamos, pasemos a ver el segundo caso:

/*
	Esto es un texto.
	Que usaremos para ver un
	comentario multi linea,
	tambien podemos ver su
	practicidad.
*/

Las multi lineas se hacen con una barra seguida de un asterisco y se cierra con un asterisco y otra barra, todo lo que este en el medio el lenguaje lo considera un comentario y por ende lo ignora pero este comentario tambien soporta una linea por ejemplo podriamos hacer esto:

/* Esto es un comentario. */

Como dijimos al principio muy poca gente lo usa para lo que mencionamos hasta ahora porque como tambien dijimos todo lo que este con los comentarios sera ignorado por el lenguaje, entonces el 100% de los programadores lo usan para anular una parte del codigo, ya sea porque es dudosa y no sabemos si esta causando un error o escribimos un codigo mejor para reemplazarlo pero no queremos eliminarlo por si nos puede servir para otra cosa, por ejemplo el primer comentario puede ser usado para anular una sola linea y el segundo para anular todo un bloque del codigo, para entender este concepto vamos a generar un nuevo programa llamado comentario.cs con el siguiente codigo:

comentario.cs

using System;

public class Program
{
	static int Main()
	{
		int valor = 0;
		for (int i=0; i < 10; i++)
		{
			valor += 2*i;	
			Console.WriteLine(valor);
		}
		Console.Write(valor);
		return 0;
	}
}

Este es un simple programa que cuenta de 0 a 9 por medio de un bucle for el cual lo sumara al valor anterior almacenado en valor el numero de i del ciclo for multiplicado por 2, mostrandolo tambien en pantalla por ultimo cuando sale del bucle nos muestra el valor final de valor, compilemos y veamos su salida:

C:\Users\tinchicus\Documents\Visual Studio 2019>comentarios
0
2
6
12
20
30
42
56
72
90
90
C:\Users\tinchicus\Documents\Visual Studio 2019>

Con esto tenemos un programa completamente funcional, donde nos muestra el contenido de valor en cada paso del bucle, vamo a realizar una modificacion en el bucle for:

		for (int i=0; i < 10; i++)
		{
			valor += 2*i;	
			// Console.WriteLine(valor);
		}

En este caso comentamos la linea que se encarga de mostrarnos el valor durante el bucle, si lo compilamos y probamos obtendremos esta salida:

C:\Users\tinchicus\Documents\Visual Studio 2019>comentarios
90
C:\Users\tinchicus\Documents\Visual Studio 2019>

Como pueden ver desaparecio todo el ciclo y nos quedo solamente el resultado final de valor, ahora vamos a hacer la siguiente modificacion:

		/* 
		for (int i=0; i < 10; i++)
		{
			valor += 2*i;	
			// Console.WriteLine(valor);
		}
		*/

Aca hicimos un comentario multilinea, por ende lo que hicimos fue anular el bucle for, si lo compilamos y probamos sucedera lo siguiente:

C:\Users\tinchicus\Documents\Visual Studio 2019>comentarios
0
C:\Users\tinchicus\Documents\Visual Studio 2019>

En este caso se cumplio lo que dijimos, ya que valor solamente tendra el valor que le asignamos a un principio, este es el mayor uso que tiene los comentarios por los programadores, ahora vamos a mostrarle el verdadero uso, modificando el codigo como corresponde:

/*
	Este es un codigo de ejemplo de la pagina 
	Tinchicus.com, ya que solamente lo usaremos
	para mostrar comentarios en el codigo.

*/

using System;

public class Program
{
	static int Main()
	{
		int valor = 0; // Iniciamos a valor.
		
		for (int i=0; i < 10; i++)
		{
			// Se encarga de incrementa el contenido de valor.
			valor += 2*i;
			
			// Aca lo muestra en pantalla
			Console.WriteLine(valor);
		}
		
		// Aca mostramos el resultado final.
		Console.Write(valor);
		
		return 0; // Es el encargado de devolver un int pa' Main.
	}
}

Aca tenemos un buen uso de los comentarios, como pueden ver tenemos un comentario amplio al principio para dar una mayor descripcion de nuestro codigo, origenes y otros menesteres, luego los comentarios por linea podemos ponerlo donde queramos, tanto una linea antes como despues del punto y coma (;), esto es gracias a que el lenguaje ignorara completamente lo que haya destras de la doble barra (//), si lo compilan y prueban deberan obtener el primer resultado.

En resumen, hoy hemos visto los comentarios, para que se usan, como se deben usar, que posibilidades nos brindan, distintos tipos de comentarios, el verdadero uso que le dan los programadores, y un ejemplo donde vemos todo lo dicho en practica, espero les haya sido util sigueme en tumblr, Twitter o Facebook para recibir una notificacion cada vez que subo un nuevo post en este blog, nos vemos en el proximo post.

Tengo un Patreon donde podes acceder de manera exclusiva a material para este blog antes de ser publicado, sigue los pasos del link para saber como.