Los comentarios nos permiten incluir notas y explicaciones dentro del código. Estas notas ayudan a que el código sea más fácil de entender tanto para otros programadores, como para nosotros mismos al revisar el proyecto en el futuro.
Además, los comentarios permiten desactivar temporalmente fragmentos de código sin eliminarlos, lo que es útil para pruebas y depuración (pero solo para pruebas, dejarlo ahí es una guarrada 😊).
En C#, existen varios tipos de comentarios que permiten anotar el código de diferentes maneras:
Comentarios de una sola línea: Para notas breves y aclaraciones específicas.
Comentarios de múltiples líneas: Para explicaciones más extensas que abarcan varias líneas.
Comentarios XML: Usados para documentar el código y generar documentación automática.
Si quieres aprender sobre Comentarios en programación
consulta el Curso de Introducción a la Programación leer más
Comentarios de una línea
Los comentarios de una sola línea en C# comienzan con dos barras diagonales (//). Todo el texto que se encuentra después de // en la misma línea es considerado un comentario y es ignorado por el compilador.
Estos comentarios son apropiados para breves anotaciones o para desactivar temporalmente una línea de código:
// Este es un comentario de una sola línea
int resultado = 5 + 3; // Suma de dos númerosEste tipo de comentario es útil para describir brevemente lo que hace una línea de código específica sin interrumpir la legibilidad del mismo.
Comentarios de múltiples líneas
Cuando se necesita hacer comentarios más extensos, los comentarios de múltiples líneas son una opción adecuada. Estos comentarios comienzan con /* y terminan con */.
Todo lo que se encuentre entre estos dos símbolos será tratado como comentario y no será ejecutado.
/* Este es un comentario de múltiples líneas.
Puede abarcar varias líneas y es útil
cuando se necesita explicar el propósito de
un bloque de código o incluir una descripción detallada. */
int resultado = 5 * 10;Los comentarios de múltiples líneas son útiles cuando se necesita escribir una explicación detallada o cuando se desea desactivar un bloque de código completo durante el proceso de depuración.
Comentarios XML
C# también permite crear comentarios XML, los cuales son especialmente útiles para documentar métodos, clases y propiedades.
Los comentarios XML comienzan con tres barras diagonales (///) y pueden contener etiquetas como <summary>, <param>, y <returns>. Aquí tienes un ejemplo:
/// <summary>
/// Calcula la suma de dos números enteros.
/// </summary>
/// <param name="a">El primer número a sumar.</param>
/// <param name="b">El segundo número a sumar.</param>
/// <returns>El resultado de la suma de ambos números.</returns>
public int Sumar(int a, int b)
{
return a + b;
}En este ejemplo:
<summary>describe el propósito del método.<param>describe los parámetros de entrada.<returns>describe el valor de retorno.
Los comentarios XML se utilizan para crear documentación detallada que puede ser exportada y usada por otros desarrolladores, ayudando a entender la funcionalidad de cada método o clase.