Gostaria de saber quais as informações relevantes que realmente não devem faltar no Javadoc. Isto é, o que realmente eu devo documentar? Exemplos, por favor.
Solucionado (ver solução)
Solucionado
(ver solução)
1
resposta
resposta
Tipo de informação que deve constar no Javadoc
solução!
Olá Matheus, tudo bem? Eu pesquisei bastante mas não achei nada definitivo para te responder, mas vamos partir do princípio básico. Imagine que o Javadoc é equivalente a planta de uma casa. Lá nós temos a altura do teto, largura das paredes, onde vai a instalação elétrica, hidráulica, etc. O que nessa planta tu considera relevante? Para mim a resposta seria tudo! Então, partindo dessa premissa, no Javadoc quanto mais informações do seu projeto estiverem ali melhor. Certo? Acho que trabalhando no dia a dia, nós vamos acabar percebendo melhor que talvez em um projeto X, alguma informação não seja importante mas no projeto Y sim. Um abraço!