Eu examinei a referência JavaDoc e, embora eu entenda a diferença básica entre @see
(vários links) e {@inheritDoc}
(exportação do comentário JavaDoc da superclasse), preciso de esclarecimento sobre como as coisas realmente são implementadas.
No IDE Eclipse, quando eu seleciono “Gerar comentários de elemento” para o método herdado (da interface ou substituição de toString () e assim por diante), ele cria o comentário a seguir
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
Se eu sou obrigado a produzir JavaDoc eu deveria deixar por isso mesmo, substitua @see
com {@inheritDoc}
, ou transformá-lo em bona fide JavaDoc como tal:
/**
* {@inheritDoc}
*/
E quando eu fizer isso, ainda devo manter o sinalizador de método class #?
@inheritDoc
se pretende adicionar à documentação original da superclasse. Se você simplesmente deseja que seja duplicado, o Javadoc já fará isso, observando que a documentação da superclasse se aplica ao método sobrescrito da subclasse porque a subclasse não forneceu documentação adicional.