Java: convenzione per l'utilizzo di javadoc insieme a un'annotazione del metodo?

Question

Ho il seguente metodo:

@Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Se voglio aggiungere un Javadoc per questo metodo, c'è qualche convegno su come fare questo con avere l'annotazione @Override (o qualsiasi altra annotazione)?

Il motivo per cui lo chiedo è perché ho letto che i commenti di javadoc DEVONO essere direttamente prima del metodo (nessuna nuova riga tra i due), e non sono sicuro se mettere il commento javadoc direttamente sopra l'annotazione @Override significherebbe cose sopra.

Questo sarebbe il modo convenzionale di farlo per esempio? funziona?

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Answer 1

Sì, in questo modo è la strada giusta, non ho ancora visto il contrario. E sì, funziona così. Non ho provato il contrario.

/** 
    * This is my method's javadoc comment. 
    */ 
    @Override 
    public boolean myMethod() 
    { 
     // do stuff 
    } 

Ma in fondo io di solito vorrei non aggiungere un commento javadoc a un metodo che sovrascrive un altro metodo, in particolare in sede di attuazione delle interfacce. Il tag @inheritDoc è utile qui, per distribuire la documentazione senza grandi sforzi. Ma questo è specifico di questo esempio, potresti aggiungere anche altre annotazioni.

Answer 2

Sì, funzionerà correttamente. Ad esempio, nel source code of java.lang.String da openjdk, stanno usando javadoc sopra l'annotazione @Deprecated.