2
votes

Comment définir javadoc des bibliothèques externes dans IntelliJ Idea?

Dans IntelliJ Idea, j'ai défini le javadoc hors ligne du SDK Java dans Structure du projet -> SDK -> Chemins de documentation et j'ai ajouté le chemin au dossier de documentation. Chaque fois que je veux voir l'infobulle, j'appuie simplement sur Ctrl + Q pour voir la documentation hors ligne d'un symbole au caret. Mais cela ne fonctionne que pour le SDK Java. Par exemple, j'utilise la bibliothèque servlet-api.jar, j'ai téléchargé servlet-api javadoc, mais je ne peux en aucun cas l'importer dans IntelliJ Idea. J'ai essayé de l'ajouter aux SDK -> Chemins de documentation mais cela n'a pas fonctionné. Est-ce un moyen d'importer du javadoc hors ligne d'autres bibliothèques pour voir facilement les info-bulles?

Cette tentative ne fonctionne pas. entrez la description de l'image ici


0 commentaires

3 Réponses :


2
votes

Vous pouvez charger votre API dans les bibliothèques de votre projet avec les javadocs.

Ouvrez la structure de votre projet (Ctrl + Alt + Maj + S). Ajoutez votre bibliothèque (comme Servlet-api de maven)

 entrez la description de l'image ici

assurez-vous de cocher la case JavaDocs

 entrez la description de l'image ici

Vous pouvez maintenant utiliser Ctrl + Q avec cette bibliothèque.

MODIFIER : Voici un exemple de méthode info () de la documentation de la bibliothèque log4j Ctrl + Q:

! [entrez la description de l'image ici

la fenêtre contextuelle peut être redimensionnée pour afficher le contenu. Faites simplement glisser le bas à droite.
Ou utilisez la fenêtre d'outils pour la documentation avec Affichage> Fenêtre d'outils> Documentation .

Faites-moi savoir si cela vous aide.


6 commentaires

Merci pour les conseils, j'ai téléchargé la bibliothèque de Maven avec Javadocs mais malheureusement le problème persiste. En survolant le symbole ou en appuyant sur Ctrl + Q, je ne vois que la fenêtre vide avec le nom du symbole. Je l'ai réessayé après avoir redémarré Idea avec le même résultat. Cela fonctionne-t-il dans votre idée?


Salut @ Petr.M, voyez mon EDIT dans la réponse pour ce que j'obtiens, lorsque j'appuie sur Ctrl + Q. J'utilise IntelliJ 2018.3.2 sur un Windows 10.


Salut @hce, merci pour plus d'informations. Au début, ajouter javadoc dans la fenêtre Structure du projet via Maven n'a pas du tout aidé, mais c'était uniquement parce que ce type de projet n'était pas Maven - c'était un type de projet d'application Web Java Enterprise. J'ai donc dû ajouter dans la structure du projet ce jar servlet-api en tant que bibliothèque Java (pas de l'option Maven), puis y ajouter l'emplacement de javadoc sur mon disque. Ensuite, l'info-bulle fonctionne au survol, via Ctrl + Q et également via Shift + F1 (ouvre JavaDoc dans le navigateur). Votre solution fonctionne parfaitement pour les projets de type Maven.


Salut @ Petr.M, merci d'avoir indiqué le type de projet. Je n'y penserais pas.


J'ai donc ouvert un projet dans IDEA, et il y a un tas de dépendances dans pom.xml, qui ont été automatiquement ajoutées à la structure du projet en tant que bibliothèques «Java» simples, non traitées spécialement comme un type «Maven». Dois-je vraiment les rajouter manuellement en tant que bibliothèques «Maven», juste pour profiter des fonctionnalités de documentation rapide?


Oh, jamais. Cliquez à nouveau avec le bouton droit sur ce pom.xml et choisissez Maven | Téléchargez [Sources et] Documentation .



1
votes

Utilisez le bouton Ajouter dans Boîte de dialogue Configurer la bibliothèque pour ajouter la documentation: entrez la description de l'image ici


0 commentaires

1
votes

Lorsque le type de projet n'est pas Maven ou Gradle, l'ajout de Javadoc pour une bibliothèque particulière se fait via les paramètres de la structure du projet (Ctrl + Maj + Alt + S). Ajoutez une bibliothèque en choisissant Java dans l'option. Ajoutez ensuite un JavaDoc particulier pour cette bibliothèque. Ensuite, choisissez appliquer. Pour voir la fenêtre de l'info-bulle non seulement en appuyant sur Ctrl + Q mais aussi en survolant le symbole, choisissez Fichier -> Paramètres -> Éditeur -> Général -> et cochez Afficher la documentation rapide lors du déplacement de la souris.

 ajout d'une bibliothèque

 ajout de javadoc

 avant d'appliquer


0 commentaires