web-dev-qa-db-fra.com

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

Puis-je utiliser des touches de raccourci dans Android studio pour générer des commentaires javadoc?

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

android-studiojavadoc
167
qinxianyuzou

Je ne trouve aucun raccourci pour générer des commentaires javadoc. Mais si vous tapez /** avant la déclaration de la méthode et appuyez sur Entrée, le bloc de commentaires javadoc sera généré automatiquement.

Lisez this pour plus d'informations.

331
DouO

Pour générer des commentaires, tapez /** clé avant la déclaration de la méthode et appuyez sur Enter. Il générera un commentaire javadoc.

Exemple: 

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

Pour plus d'informations, consultez le lien https://www.jetbrains.com/idea/features/javadoc.html

99
Amey Haldankar

Voici exemple d'un commentaire JavaDoc d'Oracle :

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally Paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

Le format de base peut être généré automatiquement de l’une des manières suivantes:

  • Placez le curseur au-dessus de la méthode et tapez /** + Enter
  • Positionnez le curseur sur le nom de la méthode et appuyez sur Alt + Enter > cliquez sur Ajouter JavaDoc enter image description here
33
Suragch

Vous pouvez installer le plugin JavaDoc à partir de Paramètres-> Plugin-> Parcourir les référentiels.

obtenir la documentation du plugin à partir du lien ci-dessous

Document du plugin JavaDoc

 enter image description here

15
darwin

Vous pouvez utiliser le style Eclipse de génération de commentaires JavaDoc via "Correction du commentaire de doc" . Ouvrez "Préférence" -> "Keymap" et affectez l'action "Correction de commentaire de doc" à la clé souhaitée.

10
Kohei Mikami

Ici, nous pouvons quelque chose comme ceci ... Et au lieu d’utiliser un raccourci, nous pouvons écrire des commentaires "par défaut" au niveau classe/paquet/projet. Et modifier selon l'exigence

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

L’avantage est que vous pouvez créer un bloc de commentaires pour all the methods at a time.

7
Mr.India

Les commentaires Javadoc peuvent être automatiquement ajoutés à l'aide de la fonctionnalité de saisie semi-automatique de votre IDE. Essayez de taper /** et de frapper Enter générer un exemple de commentaire Javadoc.

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */
7
kuldeep kumar

Dans Android Studio, vous n'avez pas besoin du plug-in. Sur un Mac, ouvrez simplement Android Studio -> cliquez sur Android Studio dans la barre supérieure -> cliquez sur Préférences -> recherchez des modèles de fichiers et de codes dans la liste -> sélectionnez une inclusion -> créez-la et sera persistant dans tout votre projet

5
Robert Warren

Il suffit de sélectionner (cliquer) le nom de la méthode, puis d'utiliser la combinaison de touches Alt + Entrée, sélectionnez "Ajouter un JavaDoc".

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

2
Jim Robbins

Dans Android studio, nous avons peu de façons de générer automatiquement des commentaires:

  • Méthode I:

En tapant/** puis en appuyant sur Entrée, vous pouvez générer la ligne de commentaire suivante. Les paramètres, etc., seront automatiquement générés, mais vous aurez besoin du raccourci clavier pour cette méthode de vérification II.

  • ** Méthode II: **

1 - Aller au top menu 

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 "commentaire du document" dans les résultats et double-cliquez dessus

6 - Sélectionnez Ajouter un raccourci clavier dans la liste déroulante ouverte après un double clic.

7 - Appuyez sur les touches de raccourci sur le clavier 

8 - Allez à votre code et où vous voulez ajouter un commentaire appuyez sur la touche de raccourci 

9 - Profitez-en!

1
Noir

  • Une autre façon d’ajouter un commentaire Java est d’appuyer sur: Ctrl + Maj + A >> afficher une fenêtre contextuelle >> tapez: Ajouter des javadocs >> Entrée.

  • Ctrl + Shirt + A: Consultation de commande (nom de commande à complétion automatique) 

 enter image description here

1
huu duy

Android Studio -> Préférences -> Éditeur -> Intentions -> Java -> Déclaration -> Activer "Ajouter JavaDoc"

Et, lorsque vous sélectionnez Méthodes à implémenter (Ctrl/Cmd + i), en bas à gauche, vous devriez voir la case à cocher pour activer la copie JavaDoc.

0
sayaMahi

Je ne suis pas sûr de bien comprendre la question, mais une liste de raccourcis clavier peut être trouvée ici - J'espère que ça aide!

0
fantasitcalbeastly

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

0
Brill Pappin