Minha dúvida é bem simples, porém acredito que não seja só minha, mas como de diversos iniciantes em java…
O que devemos colocar em cada linha do javadoc ? Por exemplo, eu já sei que no @since a gente coloca a data da última modificação, assim como sei o @author e o @version porém não sei para que serve as outras …
Só para lembrar :
@ param
@ deprecated
@ excepition
@ return
@ see
@ throws
@ serial data
Existe um plugin se chama jautodoc, ele faz bastante coisa automaticamente já, o resto ve no google né
@param serve para descrever os parâmetros de um metódo ou constructor.
@deprecated serve para indicar que algum método, constructor, classe, etc está obsoleta e seu uso deve ser evitado.
@exception indica que aquele método ou contructor pode lançar uma exceção.
@return aqui você pode dizer o que exatamente um método retorna.
@see você pode adicionar alguma outra classe, interface, método, etc que esteja relacionado com a parte do seu código que está sendo documentada.
@throws é sinônimo de @exception
@serialData eu não também não entendi muito bem quando usar…
… De qualquer forma, aqui está o link da documentação oficial para que você tenha informações mais precisas.