in

java – ¿Cómo hacer referencia a un método en javadoc?

apple touch icon@2

El formato general, desde el sección @link de la documentación de javadoc, es:

{@link package.class # member label}

Método en la misma clase:

/** See also {@link #myMethod(String)}. */
void foo() { ... }

Método en un clase diferente, ya sea en el mismo paquete o importado:

/** See also {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }

Método en un paquete diferente y no importado:

/** See also {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }

Etiqueta vinculada al método, en texto sin formato en lugar de fuente de código:

/** See also this {@linkplain #myMethod(String) implementation}. */
void foo() { ... }

Una cadena de llamadas a métodos, como en tu pregunta. Tenemos que especificar etiquetas para los enlaces a métodos fuera de esta clase, o obtenemos getFoo().Foo.getBar().Bar.getBaz(). Pero estas etiquetas pueden resultar frágiles durante la refactorización; consulte «Etiquetas» a continuación.

/**
 * A convenience method, equivalent to 
 * {@link #getFoo()}.{@link Foo#getBar() getBar()}.{@link Bar#getBaz() getBaz()}.
 * @return baz
 */
public Baz fooBarBaz()

Es posible que la refactorización automatizada no afecte a las etiquetas. Esto incluye cambiar el nombre del método, clase o paquete; y cambiar la firma del método.

Por lo tanto, proporcione una etiqueta solamente si desea un texto diferente al predeterminado.

Por ejemplo, puede vincular del lenguaje humano al código:

/** You can also {@linkplain #getFoo() get the current foo}. */
void setFoo( Foo foo ) { ... }

O puede vincular desde una muestra de código con texto diferente al predeterminado, como se muestra arriba en «Una cadena de llamadas a métodos». Sin embargo, esto puede resultar frágil mientras las API evolucionan.

Si la firma del método incluye tipos parametrizados, use el borrado de esos tipos en el javadoc @link. Por ejemplo:

int bar( Collection<Integer> receiver ) { ... }

/** See also {@link #bar(Collection)}. */
void foo() { ... }

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

show

Vim – Diferencia

yyDu58VBmQpNPJhJDUxmNJ 1200 80

Flight Simulator 2020 Best Mods: Cómo encontrar e instalar mods y diseños personalizados