JavaDoc @see for MyClass constructor que devuelve una advertencia "referencia no encontrada"

Question

Estoy intentando crear javadoc para la biblioteca de mi cliente. En MyOtherClass, coloco el siguiente @see y recibo advertencias. MyOtherClass y MyClass están en diferentes paquetes, en el mismo proyecto.

@see MyClass#Constructor(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#Constructor(Type1 param1, Type2 param2) 

Luego probé

@see MyClass#MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyClass#MyClass(Type1 param1, Type2 param2) 

también trató

@see #MyClass(Type1 param1, Type2 param2) 
warning - Tag @see: reference not found: MyOtherClass#MyClass(Type1 param1, Type2 param2) 

Sé que me falta algo real tonto aquí.

Answer 1

Esto se debe a que Javadoc necesita saber la ubicación exacta de la clase a la que se refiere para crear un enlace a la misma. Simplemente agregue el paquete como se mencionó en un comentario anterior.

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) 

La herramienta javadoc le permitirá tomar atajos de la siguiente manera:

// For methods in the same class: 
@see #Constructor(Type1 p1, Type2 p2) 

// For methods in the same package: 
@see MyClass#Constructor(Type1 p1, Type2 p2) 

Si usted tiene un nombre de paquete largo y desea ocultar que se puede utilizar una etiqueta:

@see mypackage.MyClass#Constructor(Type1 p1, Type2 p2) MyClass#Constructor(Type1 p1, Type2 p2) 

Lo anterior mostrará:

Vea también:MyClass.Constructor(Type1 p1, Type2 p2)

Consulte la documentación de Oracle para obtener más here en @see

---

Advertencia: Si utiliza la función de finalización de código de algunos IDE (Por ejemplo Eclipse) para crear comentarios de Javadoc, puede agregar una importación para el paquete al que hace referencia. Si bien esto puede hacer que sus comentarios se vean más claros al excluir el nombre del paquete, no es una buena práctica agregar dependencias reales exclusivamente para la documentación.