Recuerda que en la informática un error casi siempre tiene diferentes soluciones, no obstante aquí mostramos la mejor y más óptimo.
Solución:
Encontrará mucha información sobre JavaDoc en la Especificación de comentario de documentación para el doclet estándarincluida la información sobre el
@enlace paquete.clase#etiqueta de miembro
etiqueta (que usted está buscando). El ejemplo correspondiente de la documentación es el siguiente
Por ejemplo, aquí hay un comentario que hace referencia al método getComponentAt(int, int):
Use the @link #getComponentAt(int, int) getComponentAt method.
Él package.class part puede omitirse si el método referido está en la clase actual.
Otros enlaces útiles sobre JavaDoc son:
- Referencia de la herramienta JavaDoc
- Guía JavaDoc
- Cómo escribir comentarios de documentos para la herramienta Javadoc
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 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 importados:
/** 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 ser 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()
Etiquetas
Es posible que la refactorización automatizada no afecte a las etiquetas. Esto incluye cambiar el nombre del método, la clase o el paquete; y cambiando la firma del método.
Por lo tanto, proporcione una etiqueta solamente 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 enlazar 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 evolucionan.
Escriba 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 receiver ) ...
/** See also @link #bar(Collection). */
void foo() ...
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();
Aquí tienes las reseñas y puntuaciones
Acuérdate de que tienes autorización de esclarecer si diste con la contestación.