Olá, sempre que eu atualizar o meu código e consequentemente atualizar a docmentação, preciso ir la em Project e gerar um novo javadoc?
Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!
Olá, sempre que eu atualizar o meu código e consequentemente atualizar a docmentação, preciso ir la em Project e gerar um novo javadoc?
Opa Matheus, tudo bem?
Acredito que isso faça sentido sim, pelo menos se outras pessoas forem utilizar ela. O que é comum quando você for desenvolver APIs ou até quem sabe novas libraries, por exemplo. Sobre a frequência em que você fará isso, talvez seja uma boa ideia que a cada nova versão do seu programa que for disponibilizada para outras pessoas, também tenha um javadoc especificando o propósito de cada novo método (javadoc > // comentários).
Eu também já li em algum lugar uma pessoa dizendo que usa o javadoc independentemente se outras pessoas vão precisar da documentação. A motivação foi que depois de alguns meses, muito provavelmente ela nem iria se lembrar do que alguns trechos do código fariam. De acordo com essa pessoa: "Comente a lógica, não a sintaxe... e faça apenas uma vez, no lugar apropriado. [...]".
No final das contas, assim como qualquer outra ferramenta de desenvolvimento, ela chegou para facilitar a nossa vida. Manter os usuários da sua API informados sobre como eles podem utilizá-la é essencial, mas nada impede que você use isso para facilitar a sua vida também! rs
Enfim, me diz aí se isso faz sentido para você, ou se tem algum ponto que não ficou legal!
Abraços e bons estudos!!
Oi Thiago, blza? Cara brigado por responder.