identifique - javadoc pdf

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

Question

¿Cómo puedo usar la etiqueta @link para vincular a un método?

quiero cambiar

/**
* 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()

a

/**
* 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()

pero no sé cómo formatear la etiqueta @link correctamente.

Answer 1

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

Ejemplos

Método en la misma clase:

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

Método en una 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 plano en lugar de fuente de código:

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

Una cadena de llamadas al método, 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 ser frágiles; vea "Etiquetas" a continuación.

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

Etiquetas

La refactorización automatizada puede no afectar a las etiquetas. Esto incluye cambiar el nombre del método, clase o paquete; y cambiando la firma del método.

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

Por ejemplo, puede enlazar desde el lenguaje humano al código:

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

O puede vincular desde un ejemplo de código con un texto diferente al predeterminado, como se muestra arriba en "Una cadena de llamadas a métodos". Sin embargo, esto puede ser frágil mientras las API están evolucionando.

Tipo de borrado y #miembro

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() { ... }

Answer 2

Encontrará mucha información sobre JavaDoc en la Especificación de comentario de documentación para el Doclet estándar , incluida la información en el

{@link package.class # etiqueta de miembro}

etiqueta (que estás buscando). El ejemplo correspondiente de la documentación es el siguiente.

Por ejemplo, aquí hay un comentario que se refiere al método getComponentAt (int, int):

Use the {@link #getComponentAt(int, int) getComponentAt} method.

La parte package.class puede ser solicitada si el método referido está en la clase actual.

Otros enlaces útiles sobre JavaDoc son:

• Referencia de la herramienta JavaDoc
• Guia de JavaDoc
• Cómo escribir comentarios de doc para la herramienta Javadoc

Answer 3

Puedes usar @see para hacer eso:

muestra:

interface View {
/**
* @return true: have read contact and call log permissions, else otherwise
* @see #requestReadContactAndCallLogPermissions()
*/
boolean haveReadContactAndCallLogPermissions();
/**
* if not have permissions, request to user for allow
* @see #haveReadContactAndCallLogPermissions()
*/
void requestReadContactAndCallLogPermissions();
}