1
resposta

Quais são as melhores praticas para se incluir comentário na classe ou construtores?

    /**************************************************************************/
    /* Objetivo : Inclusão de Conta Corrente.                                 */
    /* Dados de entrada: numero da agencia                                    */
    /*                   numero da conta corrente                             */
    /* Dados de saída  : nenhum                                               */
    /**************************************************************************/
    public ContaCorrente (int agencia, int numero)
1 resposta

Olá Roberto!

Comentário em código é um assunto relativamente polêmico. :)

No geral o objetivo é que você não precise utilizar comentários e que seu código seja autoexplicativo, contudo, comentários são uteis especialmente para pessoas que vão consumir o seu código (e não precisam entender exatamente o que ele faz internamente). Nesse caso, comentários com uma visão high-level são uteis.

Nesses casos, eu recomento utilizar o próprio recurso de documentação do C#. Utilizando o seu código como exemplo, ficaria assim:

    /// <summary>
    /// Inclusão de Conta Corrente
    /// </summary>
    /// <param name="agencia">numero da agencia</param>
    /// <param name="numero">numero da conta corrente</param>
    public ContaCorrente(int agencia, int numero)
    {

    }

A documentação feita dessa forma é exibida quando o seu código for consumido (ou seja, quando um objeto da classe ContaCorrente for instanciado, seus comentários serão exibidos).

Para iniciar a documentação dos seus métodos e construtores digite /// em cima da declaração do método, o Visual Studio vai gerar a base pra você.

Abraço!