248 votes

Comment générer des commentaires javadoc dans Android Studio

Puis-je utiliser des raccourcis clavier dans Android studio pour générer des commentaires javadoc ?

Sinon, quel est le moyen le plus simple de générer des commentaires javadoc ?

2voto

Jim Robbins Points 61

Il suffit de sélectionner (c'est-à-dire de cliquer) le nom de la méthode, puis d'utiliser la combinaison de touches Alt+Enter et de sélectionner "Add JavaDoc".

Cela suppose que vous n'avez pas déjà ajouté des commentaires au-dessus de la méthode, sinon l'option "Add JavaDoc" n'apparaîtra pas.

2voto

Noir Points 188

Dans Android Studio, nous avons quelques moyens de générer automatiquement des commentaires :

  • Méthode I :

En tapant /** et en appuyant ensuite sur Entrée, vous pouvez générer la ligne de commentaire suivante et cela générera automatiquement les paramètres, etc. mais si vous avez besoin du raccourci clavier pour cela, consultez la méthode II ci-dessous.

  • **Méthode II : **

1 - Goto topMenu

2 - Fichier > Paramètres

3 - Sélectionnez Keymap dans les paramètres

4 - Dans la barre de recherche en haut à droite, recherchez "Fix Doc".

5 - Sélectionnez le "fix doc comment" dans les résultats et double-cliquez dessus.

6 - Sélectionnez Ajouter un raccourci clavier dans le menu déroulant qui s'ouvre après le double-clic.

7 - Appuyez sur les touches de raccourci du clavier

8 - Allez dans votre code et à l'endroit où vous voulez ajouter un commentaire, appuyez sur le raccourci clavier.

9 - Profitez-en !

1voto

Brill Pappin Points 1662

Il suffit de sélectionner la version Eclipse du keycap dans les paramètres du Keymap. Un Keymap Eclipse est inclus dans Android Studio.

1voto

Yudi karma Points 90

Je l'ai recommandé Dokka pour une javadoc générique avec des commentaires et plus encore

1voto

CoolMind Points 11

Parce que la plupart d'entre nous utilisent Kotlin vous pouvez générer des JavaDoc (KDoc). utiliser des plugins . Dans Android Studio, ouvrez Settings (presse Ctrl + Alt + S ), sélectionnez Plugins et trouver kdoc . J'ai téléchargé KDoc-er mais vous pouvez choisir n'importe lequel d'entre eux. Puis redémarrez Android Studio.

Trouvez n'importe quelle classe/méthode, tapez /** , appuyez sur Enter . Vous obtiendrez une courte description comme :

/**
 * User data
 *
 * @property name
 * @property avatar
 * @property gender
 * @constructor Create empty User data
 */
class UserData(...

enter image description here

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X