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


204

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

Sinon, quelle est la façon la plus simple de générer des commentaires javadoc?


Cette question est 50/50. Vous recherchez soit des blocs javadoc simples pour générer du javadoc dans tout le document. Lequel est-ce?
K - La toxicité du SO augmente.

ALTR + ENTRÉE montrent la vue que vous pouvez générer le commentaire des méthodes déjà déclarées.
Zala Janaksinh

Peut-être que vous devez ajouter un modèle Live (studio Android - réglage - éditeur - Modèles Live - ajouter) pour cela. Dans le champ de texte du modèle, ajoutez le texte suivant. / ** * $ comment $ * /
Johnett Mathew

Réponses:


388

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

Lisez ceci pour plus d'informations.


7
Il est dommage que cela ne fonctionne pas également pour générer des commentaires javadoc pour les classes, les champs, etc. Ce serait encore plus agréable s'il générait javadoc à partir d'un modèle personnalisable.
Ted Hopp du

23
bien sûr, il a un raccourci: position sur la méthode / le nom du constructeur et appuyez sur alt + entrée, choisissez générer javadoc dans le menu
Ewoks

référez -en plus à la solution ci-dessus
Pritesh Vishwakarma

110

Pour générer des commentaires, tapez /**key avant la déclaration de 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


4
@satheeshwaran - vraiment? C'est la même réponse que celle de DouO (réponse originale), sauf qu'elle a un exemple. Même le lien est une copie. L'exemple aurait dû être ajouté à la réponse originale.
CJBS

3
@satheeshwaran - pour ce que ça vaut, je peux voir que juste voir l'exemple des commentaires (dans la réponse) est utile, quand on veut une réponse rapidement ;-)
CJBS

En fait, l'exemple manque d'un * avant le dernier /
Maximiliano Ambrosini

35

Voici un exemple de 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:

  • Positionnez 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 entrez la description de l'image ici

17

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

entrez la description de l'image ici


Cela fonctionne très bien. Installez le plugin JavaDoc (comme ci-dessus), puis appuyez sur CNTL + MAJ + ALT + G.
Alan Nelson

10

Vous pouvez utiliser le style éclipse de génération de commentaires JavaDoc via "Fix doc comment". Ouvrez "Préférence" -> "Keymap" et attribuez l'action "Fix doc comment" à la clé de votre choix.


9

Ici, nous pouvons quelque chose comme ça. Et au lieu d'utiliser n'importe quel raccourci, nous pouvons écrire des commentaires "par défaut" au niveau classe / package / projet. Et modifiez 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.


9

Les commentaires Javadoc peuvent être automatiquement ajoutés en utilisant la fonctionnalité de saisie semi-automatique de votre IDE. Essayez de taper /**et d'appuyer Enterpour 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
 */

5

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éfrences -> trouvez les modèles de fichiers et de codes dans la liste -> sélectionnez inclut -> construisez-le et sera persistant dans tout votre projet


2
  • Une autre façon d'ajouter un commentaire sur les documents Java consiste à appuyer sur: Ctrl + Maj + A >> afficher une fenêtre contextuelle >> taper: Ajouter des javadocs >> Entrer.

  • Ctrl + Chemise + A: Recherche de commande (nom de la commande de saisie semi-automatique)

entrez la description de l'image ici


2

Sélectionnez simplement (c.-à-d. Cliquez) le nom de la méthode, puis utilisez la combinaison de touches Alt + Entrée, sélectionnez "Ajouter 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

Dans Android studio, nous avons plusieurs 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 et elle générera automatiquement les paramètres, etc. mais lorsque vous aurez besoin du raccourci clavier pour cette méthode de vérification II ci-dessous.

  • ** Méthode II: **

1 - Aller au 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 "fix doc comment" 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 du clavier

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

9 - Profitez-en!


La façon la plus pratique d'ajouter des documents. Par exemple, j'ai attribué "'" et entrez comme raccourci
CodeToLife

1

Sélectionnez simplement la version Eclipse du keycap dans les paramètres Keymap. Un clavier Eclipse est inclus dans Android Studio.


0

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 cela vous aidera!


2
Dans éclipse pour ajouter des commentaires javadoc, appuyez sur Alt + Maj + J, mais dans AndroidStudio mais je ne sais pas comment faire
qinxianyuzou

Si je me souviens bien, ce raccourci ne fonctionnait que si vous aviez installé et activé le plugin 'jautodoc'.
Matt

0

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

Et, lors de la sélection des méthodes à implémenter (Ctrl / Cmd + i), en bas à gauche, vous devriez voir la case à cocher pour activer Copier JavaDoc.



-5

ALT+ SHIFT+ Gcréera les commentaires générés automatiquement pour votre méthode (placez le curseur à la position de départ de votre méthode).


public void hideKeyboard () u devrait placer le curseur devant public et l'essayer ou s'il vous plaît vérifier si vous avez installé le doc java dans votre studio.
Dinesh IT

Ça ne marche pas non plus pour moi. Peut-être, cela fonctionne dans une carte-clé spéciale. Le clavier peut être configuré dans Préférences> Clavier. Ou le clavier a été modifié.
Oliver Kranz
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.