Visualizzare la Javadoc in Eclipse e IntelliJ IDEA

Qualche settimana fa ho avuto bisogno di visualizzare offline la Javadoc di una libreria che stavo utilizzando in un progetto.

In questo post condivido con voi quello che ho scoperto su come scaricare la documentazione di una dipendenza Maven e su come consultarla con Eclipse o con IntelliJ IDEA.

Scaricare la documentazione…

Prima di poter consultare la Javadoc di una dipendenza Maven è necessario scaricarla localmente. Il download può essere effettuato all’occorrenza o possiamo configurare il nostro ambiente di sviluppo affinché scarichi la Javadoc insieme all’artefatto della dipendenza.

… con Eclipse

In Eclipse possiamo scaricare la documentazione associata ad una dipendenza dalla sezione Maven Dependencies del nostro progetto:

Download Javadoc in Eclipse

Una volta trovata la dipendenza in questione, facciamo click col destro e nel menù contestuale selezioniamo Maven → Download Javadoc.

Se vogliamo che il download avvenga automaticamente, in fase di risoluzione della dipendenza, possiamo abilitare questa funzionalità spuntando l’opzione Download Artifact Javadoc nelle preferenze di Maven:

Eclipse Maven preferences

… con IntelliJ IDEA

Per effettuare il download della Javadoc in IntelliJ IDEA dobbiamo spostarci nel pannello Maven Projects. Nella sezione Dependencies del nostro progetto selezioniamo la dipendenza d’interesse e cliccando col destro andiamo ad effettuare un Download Documentation:

Download Javadoc in IntelliJ IDEA

Se lo preferiamo, possiamo configurare il download automatico della Javadoc delle dipendenze nel pannello Settings.

In particolare, nella sezione Build, Execution, Deployment → Build Tools → Maven → Importing andiamo a spuntare l’opzione Documentation per la voce Automatically Download:

IntelliJ Maven settings

Consultare la documentazione…

La consultazione della documentazione può avvenire in differenti modi: entrambi gli IDE esaminati prevedono una modalità quick-tip, contestuale alla scrittura del codice. Inoltre è possibile visualizzare l’intera Javadoc attraverso il browser.

… con Eclipse

Posizionando il mouse su un elemento d’interesse, vedremo apparire un popup con un estratto della documentazione:

Eclipse Quick Tip

In alternativa possiamo attivare la view Javadoc (Window → Show View → Javadoc) che permette di visualizzare la Javadoc per l’elemento selezionato:

Eclipse Javadoc View

Infine, è possibile visualizzare l’intera Javadoc della dipendenza selezionando un elemento della stessa e digitanto la shortcut Shift + F2 (o in altenativa facendo click col destro nella Javadoc view e selezionando Open Attached Javadoc):

Eclipse Javadoc Browser

Come vedete la Javadoc viene visualizzata nel browser interno di Eclipse (o in quello configurato in Window → Web Browser).

… con IntelliJ IDEA

Anche IntelliJ prevede i quick tip per gli elementi di una dipendenza. Per visualizzarli, selezioniamo ad esempio un metodo e utilizziamo la shortcut Ctrl + q:

IntelliJ IDEA quick tip

Se invece preferiamo abilitare la visualizzazione del popup al mouse-over, basterà spuntare l’opzione Show quick documentation on mouse move in Settings → Editor → General.

Come forse avrete notato nella figura precedente, nel popup visualizzato è presente un link del tipo {nome-metodo} on localhost. Facendo click su questo link, nel nostro browser verrà visualizzata la Javadoc completa della dipendenza:

IntelliJ IDEA Javadoc browser

In conclusione

In questo breve post abbiamo visto consultare la Javadoc di una dipendenza Maven, sfruttando gli strumenti di due famosi IDE: Eclipse e IntelliJ IDEA.

Per questo articolo, ho utilizzato Eclipse nella sua versione Springizzata, STS, e IntelliJ IDEA Community Edition, ma quanto descritto funziona perfettamente anche per la versione classica di Eclipse e per la versione Ultimate di IntelliJ.

Alla prossima,

David