Scrivere javadoc corretto con @see?

Question

Come si utilizza javadoc @see correttamente?

La mia intenzione è di avere una classe astratta con metodi astratti. Questi metodi hanno commenti javadoc. Ora se estendo la classe astratta, sovrascrivo i metodi e voglio usare @see.

Ma per tutti i parametri, ad esempio per return il collegamento @see non sembra funzionare. Eclipse lamenta ancora che expected @return tag.

Quindi, come posso usare questo?

public abstract class MyBase { 
    protected abstract void myFunc(); 
} 

class MyImpl extends MyBase { 

    /** 
    * @see MyBase#myFunc() 
    */ 
    @Override 
    protected void myFunc() { .. } 
} 

Answer 1

Ai fini del compresa la documentazione da una superclasse si dovrebbe usare {@inheritDoc} non @see.

Quindi ottieni i documenti della superclasse. Puoi aggiungerlo e puoi sostituire le cose come @param e @return se necessario.

public abstract class MyBase { 
    /** 
    * @param id The id that will be used for... 
    * @param good ignored by most implementations 
    * @return The string for id 
    */ 
    protected abstract String myFunc(Long id, boolean good); 
} 

class MyImpl extends MyBase { 

    /** 
    * {@inheritDoc} 
    * @param good is used differently by this implementation 
    */ 
    @Override 
    protected String myFunc(Long id, boolean good) { .. } 
}