Como posso usar a @link
tag para vincular a um método?
Eu quero mudar:
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to getFoo().getBar().getBaz()
* @return baz
*/
public Baz fooBarBaz()
para:
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
* @return baz
*/
public Baz fooBarBaz()
mas não sei como formatar a @link
tag corretamente.
Respostas:
Você encontrará muitas informações sobre o JavaDoc na Especificação de Comentários da Documentação do Doclet Padrão , incluindo as informações no
tag (que você está procurando). O exemplo correspondente da documentação é o seguinte
A
package.class
peça pode ser omitida se o método referido estiver na classe atual.Outros links úteis sobre o JavaDoc são:
fonte
O formato geral, da seção @link da documentação do javadoc , é:
Exemplos
Método na mesma classe:
Método em um classe diferente, no mesmo pacote ou importado:
Método em um pacote diferente e não importado:
Rótulo vinculado ao método, em texto simples, em vez de fonte de código:
Uma cadeia de chamadas de método, como na sua pergunta. Temos que especificar rótulos para os links para métodos fora desta classe, ou obtemos
getFoo().Foo.getBar().Bar.getBaz()
. Mas esses rótulos podem ser frágeis; consulte "Etiquetas" abaixo.Etiquetas
A refatoração automatizada pode não afetar os rótulos. Isso inclui renomear o método, classe ou pacote; e alterando a assinatura do método.
Portanto, forneça um rótulo apenas se desejar um texto diferente do padrão.
Por exemplo, você pode vincular da linguagem humana ao código:
Ou você pode vincular a partir de um exemplo de código com texto diferente do padrão, como mostrado acima em "Uma cadeia de chamadas de método". No entanto, isso pode ser frágil enquanto as APIs estão evoluindo.
Digite apagamento e #member
Se a assinatura do método incluir tipos parametrizados, use o apagamento desses tipos no javadoc @link. Por exemplo:
fonte
você pode usar
@see
para fazer isso:amostra:
fonte