Quelle est la touche de raccourci IntelliJ pour créer un commentaire javadoc?

150

Dans Eclipse, je peux appuyer sur Alt+ Shift+ Jet obtenir un commentaire javadoc généré automatiquement avec des champs, des retours ou tout ce qui serait applicable à ce commentaire javadoc spécifique. Je suppose qu'IntelliJ IDEA a cette fonctionnalité. Quelqu'un peut-il me dire s'il existe un raccourci clavier pour cela?

Josh-Cain
la source

Réponses:

290

Taper /**+ puis appuyer Enterau-dessus d'une signature de méthode créera des stubs Javadoc pour vous.

Rachel Gallen
la source
3
Lors du remplacement d'une méthode, eclipse ajoute une balise @see avec un lien vers la méthode parente. IntelliJ peut-il faire de même?
Καrτhικ
4
Le lien @ RachelGallen est mort, voir jetbrains.com/help/idea/creating-documentation-comments.html
boardtc
1
@boardtc merci pour la mise à jour. J'ai en fait essayé de revoir le lien récemment et tout le site était en panne. Joli.
Rachel Gallen
1
cela semble créer uniquement le bloc de commentaires, pas de talon réel
Ghilteras
@RachelGallen pourrait vous aider avec ce stackoverflow.com/q/61094391/2810718
user2810718
85

Vous pouvez utiliser l'action « Corriger le commentaire du document ». Il n'a pas de raccourci par défaut, mais vous pouvez lui attribuer le raccourci Alt+ Shift+ Jdans le Keymap, car ce raccourci n'est utilisé pour rien d'autre. Par défaut, vous pouvez également appuyer deux fois sur Ctrl+ Shift+ Aet commencer à taper Fix doc commentpour trouver l'action.

krm
la source
6
Pour toute personne recherchant comment faire pour qu'IntelliJ mette à jour javadoc après un changement de code, vous pouvez définir cela dans Paramètres -> Paramètres IDE -> Keymap.
Mark McDonald
Comment exécutez-vous cette "action"?
Stealth Rabbi
@StealthRabbi "Help -> Find Action" et tapez "fix d" (ou le "Ctrl + Shift + A" mentionné dans la réponse, sauf si vous l'avez remappé).
Ped7g
1
Dois-je sélectionner quelque chose? Même si je sélectionne tout le contenu du fichier ou que je ne sélectionne rien, rien ne se passe si j'exécute cette action. Mai je manque quelque chose
Honsa Stunna
2
@Honsa Stunna, nous devons cliquer exactement sur la ligne de méthode et passer à l'action.
Mukundhan
32

Raccourci Alt+ Enteraffiche les actions d'intention où vous pouvez choisir "Ajouter Javadoc".

Robert Jakubowski
la source
2
Je pense que cela pourrait être en désaccord avec cette déclaration. Vous devez définir un pointeur sur le nom.
Robert Jakubowski
3
placez le curseur sur le nom de la méthode que vous souhaitez ajouter javadoc, puis appuyez sur alt + entrée, il y aura une option add javadoc dans le popup.Si la méthode a déjà un javadoc, alors il n'y aura pas d'option add javadoc.
Chaojun Zhong
2
à mon humble avis
Fabian Barney
2
La seule confusion que j'ai vue est que les gens demandent à mettre le curseur dans la fonction / classe / variable pour générer des documents java. Vous devez garder le curseur sur l'objet pour lequel vous générez la documentation, comme vous allez importer une classe en gardant le curseur sur l'objet et en AltEnter
appuyant