Ainda não tem acesso? Estude com a gente! Matricule-se
Ainda não tem acesso? Estude com a gente! Matricule-se

Solucionado (ver solução)

É uma boa prática documentar todos os itens do código?

Saudações!

Na aula o professor Guilherme nos mostra como pode ser feito a documentação do código, quando se habilita a opção no Visual Studio para gerar documentação XML ele marca praticamente todos os itens como classes, métodos, atributos etc, como passiveis de serem documentados, é uma boa prática documentar todos eles? Ou isso poluiria muito o código?

Exemplo de Doc:

    /// <summary>
    /// Define uma conta corrente para o banco ByteBank
    /// </summary>
    public class ContaCorrente
    }
    // Código
    }
1 resposta
solução

Olá Vinicius!

Como boa pratica é sim, assim como comentar o seu código!

Eu particularmente sempre pondero se essa documentação faria alguma diferença para outro programador entender, pois muitas vezes o nome do método ou classe já diz o suficiente.

Isso me força a sempre escrever métodos e classes com nomes mais concisos.

Agora, se você está apenas estudando, não precisa fazer a documentação, foca no curso!

Espero ter te ajudado, se ainda ficar com dúvida, pode perguntar!

Abraços!

Quer mergulhar em tecnologia e aprendizagem?

Receba a newsletter que o nosso CEO escreve pessoalmente, com insights do mercado de trabalho, ciência e desenvolvimento de software