2011-09-12 13 views
12

Sto lavorando su un'applicazione che è costantemente riscritta per migliorarlo. Ora, se rinominiamo una determinata classe per catturare meglio la sua intenzione, tutta la documentazione che menziona la classe non viene aggiornata automaticamente, a meno che non si utilizzino collegamenti ({@link ClassName}) per fare riferimento alla classe.Fare JavaDoc robusta contro il refactoring

principi JavaDoc tuttavia affermano che si dovrebbe "Utilizzare i collegamenti in linea economicamente", dal momento che i collegamenti spiccano e attirare l'attenzione dei lettori, che trovo sensato. Inoltre non puoi collegare ai parametri di un metodo.

Esiste un altro modo in JavaDoc di fare commenti più robusto di refactoring che non sono a conoscenza?

+2

Come si esegue il refactoring? Quando si rinomina in Eclipse, è possibile cercare tra i commenti. –

+0

Sì, uso Eclipse e ricordo di averlo visto. Non ho tuttavia l'opzione (usando Ctrl + Alt + R), e non riesco a trovare nulla nelle impostazioni per cambiarlo. Ad ogni modo, ciò funzionerebbe molte volte, ma ovviamente può essere ambiguo. – alexsb

+5

IntelliJ ricerca attraverso commenti, stringhe e file per trovare le cose da rinominare. Offre anche la possibilità di rinominare campi, variabili e parametri. Suppongo che Eclipse faccia lo stesso. –

risposta

5

Quando si utilizza Eclipse per fare refactoring è possibile cercare attraverso riferimenti a stringa in cose come file XML pure.

Premere Shift-Alt-R due volte per ottenere la finestra di dialogo. (Su Mac è Opzione-Comando-R due volte)

+0

Grazie! Non era quello che stavo veramente cercando, ma immagino che sia la soluzione migliore per me. – alexsb

+0

Penso che sia Alt + Shift + R ora. –

+0

Entrambi non cercherà in {@link} – Gangnus