Cómo comentar métodos en C#
Comentar métodos en C# es una práctica recomendada para mejorar la legibilidad y el mantenimiento del código. Se utiliza la documentación XML para generar descripciones detalladas de los métodos, parámetros y valores de retorno.
Comentarios XML en C#
En C#, se emplean comentarios XML (///) para documentar métodos. Esto permite que las herramientas de desarrollo, como Visual Studio, muestren información contextual sobre el código.
Ejemplo de comentario en un método:
/// <summary>
/// Suma dos números enteros.
/// </summary>
/// <param name="a">Primer número entero.</param>
/// <param name="b">Segundo número entero.</param>
/// <returns>La suma de ambos números.</returns>
public int Sumar(int a, int b)
{
return a + b;
}Los elementos XML más comunes son:
-
<summary>: Breve descripción del método. -
<param>: Explicación de cada parámetro del método. -
<returns>: Describe el valor de retorno de la función.
Ejemplos adicionales
Ejemplo con excepciones:
/// <summary>
/// Divide dos números enteros.
/// </summary>
/// <param name="dividendo">Número a dividir.</param>
/// <param name="divisor">Número por el cual se divide.</param>
/// <returns>Resultado de la división.</returns>
/// <exception cref="DivideByZeroException">Se lanza si el divisor es cero.</exception>
public double Dividir(int dividendo, int divisor)
{
if (divisor == 0)
throw new DivideByZeroException("No se puede dividir por cero.");
return (double)dividendo / divisor;
}
Jorge García
Fullstack developer