Eu tenho 3 projetos Java no meu GitHub e queria saber se faz sentido eu utilizar o javadoc neles? Já que o javadoc serve para documentar o projeto para outros desenvolvedores.
Solucionado
Eu tenho 3 projetos Java no meu GitHub e queria saber se faz sentido eu utilizar o javadoc neles? Já que o javadoc serve para documentar o projeto para outros desenvolvedores.
Acabei colocando javadoc no meu projeto kkkk
Ola Lucas tudo bem?
Então os comentários do tipo JavaDoc são importantes não somente para gerar o HTML da documentação, mas também para a leitura da propria IDE. Ao comentar uma classe ou metodo com estes comentários, um desenvolvedor que for usar as classes pode entender melhor o que está acontecendo.
Quanto a geração do HTML, eu vejo necessidade quando criamos uma lib publica, onde as pessoas podem de fato interessar em conhecer mais profundamente o código.
No mais, em seu GitHub, não vejo problema algum estar no HTML ali.