Używając Javadoc 1.5, nie mogłem utworzyć @link do wartości wyliczenia.
To, co chciałbym zrobić, to utworzyć wyliczenie w następujący sposób:
public enum Planet {
/**
* MERCURY is a fun place.
*/
MERCURY,
/**
* VENUS is more fun.
*/
VENUS,
/**
* But nothing beats the Earth.
*/
EARTH,
/**
* Others we know nothing about.
*/
OTHERS
}
Następnie odwołaj się do Javadoc for Earth, korzystając z takiego linku:
{@link Planet.EARTH}
Próbowałem też {@link Planet#EARTH}
stylu, ale bezskutecznie.
Czy ktoś wie, czy jest to w ogóle wykonalne?
Aby to sprawdzić, używam Eclipse, ale
styl wydaje się działać. Jednak normalnie wolę
tak czy siak. Nie jestem pewien, czego używa Eclipse do generowania Javadoc, ale używam JDK6. Jednak może @see załatwi sprawę za Ciebie.
źródło
@see
ale czasami potrzebujesz specjalnych przypadków. Na przykład moje zamówienia mająisWithdrawn()
metodę, a ja konkretnie mówię@return true if the status of this order is equal to OrderStatus#WITHDRAWN, false otherwise
Dopóki jest zaimportowany, możesz go połączyć (ale kiedy to zrobisz, IMO powoduje bałagan importu - które z nich są używane w kodzie, a jakie w javadoc? Lubię po prostu używać w pełni kwalifikowanej nazwy).
Ale tak, Eclipse może zająć się tym wszystkim i standardowo
działa w porządku.
Jeśli używasz Eclipse, Ctrl + Shift + O (na PC) lub Cmd + Shift + O (na Macu) automatycznie dostosowujesz import (oznacza to, że jeśli nie używasz dodatkowych importów, są one usuwane, a także dodawane wszelkie potrzebne importy).
źródło