Documentando o código com summary C#

Documentando o código com summary C#

  25 de fevereiro de 2016    henrique

---

Documentar o código é extremamente importante, principalmente quando se trabalha em projetos grandes, onde muitas vezes se tem vários programadores trabalhando cada um fazendo uma parte dele, ou então, mesmo sendo somente você no projeto, em algum momento futuro se tiver que olhar o código novamente, tê-lo documentado é muito útil.

Vou mostrar aqui uma das formas para documentar principalmente métodos. Essa forma é o summary, aqui vai um exemplo simples.

/// <summary>
/// Método que compara dois números e retorna true se o primeiro for maior que o segundo
/// </summary>
/// <param name="a">Inteiro para ser comparado</param>
/// <param name="b">Inteiro comparador com o anterior</param>
/// <returns>Retorna true se o primeiro número for maior que o segundo</returns>
public bool numeroMaior(int a, int b)
{
    return a > b;
}

Primeiro o que fica entre as tags summary é exibido quando se coloca a seta do mouse sobre o método escrito em algum lugar ou no autopreenchimento do visual studio.

Depois os parâmetros, essas descrições são exibidas quando se está digitando os valores.

Isso facilita e muito quando, por exemplo, se está utilizando uma classe que centraliza vários métodos, ou várias classes em um projeto, ou então vários projetos dentro de uma solution.