Pisząc właściwy javadoc za pomocą @see?
Jak korzystać z@see
javadoc poprawnie?
Moim zamiarem jest posiadanie abstrakcyjnej klasy z abstrakcyjnymi metodami. Te metody mają komentarze javadoc. Teraz, jeśli rozszerzę klasę abstrakcyjną, nadpisuję metody i chcę użyć@see
.
Ale dla wszystkich parametrów, np. Dlareturn
@see
link nie działa. Eclipse wciąż narzekaexpected @return tag
.
Więc jak mogę to wykorzystać?
public abstract class MyBase {
protected abstract void myFunc();
}
class MyImpl extends MyBase {
/**
* @see MyBase#myFunc()
*/
@Override
protected void myFunc() { .. }
}