Solucionado (ver solução)
Solucionado
(ver solução)
2
respostas

Javadoc produto interno

Por que não devemos utilizar javadoc quando estamos desenvolvendo um produto interno?

Pensava que javadoc era uma excelente maneira de padronizar a documentação. E no meu entender, boa documentação é essencial no desenvolvimento de qualquer sistema.

2 respostas
solução!

Oi Anderson, tudo bem ?

Documentação é bem importante mesmo ! Você gerar o javadoc também pode ser bem útil justamente para alguém pegar seu código e entender o que tá rolando.

Mas não seria melhor a pessoa que não sabe programar pegar seu código e conseguir ler também ? Dessa forma você consegue "evitar" gastar tempo fazendo documentação e focar no produto.

Por exemplo :

public String x(int a, int b){
    return " Resultado" + (a*a)+(b*b);
}

Para esse caso seria interessante ter um javadoc para entender o que tá acontecendo, mas e se fosse assim :

public String devolveResultadoDaSomaDosQuadrados(int a, int b){
    return " Resultado" + (a*a)+(b*b);
}

Repare que quando você for usar esse método ou qualquer outra pessoa o próprio nome do método já dispensa uma documentação.

Obrigado Matheus.