2009-04-02 21 views
21

Ho generato un'interfaccia che è molto ben documentata. Ogni metodo ha il suo JavaDoc. Le clases che implementano questa interfaccia possono avere poche differenze nella loro logica.Aggiungere nuovo JavaDoc ad esistente con il metodo super

Come posso aggiungere JavaDoc al JavaDoc esistente dalla super classe. La parola chiave

/** 
* {@inheritDoc} 
*/ 

imposta solo javaDoc della super classe sul metodo corrente. Ma quando provo ad aggiungere qualche parola, la JavaDoc del metodo Super è andato, come

/** 
* {@inheritDoc} 
* These value depends on... 
*/ 

Qualcuno ha un'idea come posso aggiornare il JavaDoc di un metodo eccellente, senza cancellare.

EDIT:

Riguardo a Brian Agnew risposta, che è buono, ma non una vera risposta;)

Si può anche avere lo stesso problema quando si desidera sovrascrivere un metodo esistente, come la vernice() in Swing e vogliono descrivere come inizializzare o gestire il comportamento di disegnare dall'esterno. Questo non è solo per la descrizione dell'interfaccia.

+6

Il problema che hai descritto sembra essere risolto in Java 7. Il tuo codice suggerito funziona piuttosto bene lì. – ubuntudroid

+0

Ottima domanda. Ho imparato qualcosa di estremamente utile oggi. Perfetto per documentare le interfacce e quindi tutti i bambini ereditano la documentazione e aggiungono le proprie cose ad essa - ad esempio alcune implementazioni che potrebbero generare qualche eccezione in più e quindi devono aggiungere un singolo '@ throws' nel Javadoc. – Timmos

risposta

12

Immagino che quando devi aggiungere qualcosa a javadoc, hai cambiato qualcosa. Quindi forse sarà corretto scrivere javadoc nello stesso modo.

/** 
* Enhanced swing paint for my cool component. 
* @see JButton#paint(); 
*/ 
@Override 
public void paint() { 
    super.paint(); 
    //my stuff 
} 
2

Non conosco alcun linguaggio JavaDoc diretto che lo faccia. Tuttavia Eclipse e IntelliJ ti permetteranno di afferrare il super JDoc e di inserirlo ... è tutt'altro che perfetto, come se avessi cambiato il supr JDoc dovrai reedit tutte le sostituzioni, ma è meglio che copia-incolla a mano ...

Problemi correlati