Como gerar comentários javadoc no Android Studio

204

Posso usar teclas de atalho no Android studio para gerar comentários javadoc?

Caso contrário, qual é a maneira mais fácil de gerar comentários javadoc?

qinxianyuzou
fonte
Esta pergunta é 50/50. Você também não procura blocos javadoc únicos de geração de javadoc em todo o documento. Qual é?
K - A toxicidade no SO está crescendo.
ALTR + ENTER mostra a visualização que você pode gerar o comentário dos métodos já declarados.
Zala Janaksinh
Talvez você deva adicionar um modelo ao vivo (estúdio Android - configuração - editor - modelos ao vivo - adicionar) para ele. No campo de texto do modelo, adicione o seguinte texto. / ** * $ comment $ * /
Johnett Mathew

Respostas:

388

Não consigo encontrar nenhum atalho para gerar comentários javadoc. Mas se você digitar /**antes da declaração do método e pressionar Enter, o bloco de comentários javadoc será gerado automaticamente.

Leia isto para mais informações.

DouO
fonte
7
É uma pena que isso também não funcione para gerar comentários javadoc para classes, campos etc. Seria ainda melhor se ele gerasse javadoc a partir de um modelo personalizável.
Ted Hopp
23
é claro que tem atalho: posição sobre método de nome / construtor e pressione Alt + Enter, escolha gerar javadoc a partir do menu
Ewoks
consulte isso mais sobre a solução acima #
Pritesh Vishwakarma
110

Para gerar comentários, digite a /**tecla antes da declaração do método e pressione Enter. Ele irá gerar um comentário javadoc.

Exemplo:

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

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

Para mais informações, consulte o link https://www.jetbrains.com/idea/features/javadoc.html

Amey Haldankar
fonte
4
@satheeshwaran - realmente? É a mesma resposta que a do DouO (resposta original), exceto que tem um exemplo. Até o link é uma cópia. O exemplo deveria ter sido adicionado à resposta original.
CJBS
3
@satheeshwaran - Por que vale a pena, eu posso ver que apenas vendo o exemplo dos comentários (a resposta) é útil, quando se quer uma resposta rápida ;-)
CJBS
Na verdade, o exemplo carece de um * antes do último /
Maximiliano Ambrosini
35

Aqui está um exemplo de um comentário JavaDoc da 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;
        }
 }

O formato básico pode ser gerado automaticamente de uma das seguintes maneiras:

  • Posicione o cursor acima do método e digite /**+Enter
  • Posicione o cursor no nome do método e pressione Alt+ Enter> clique em Adicionar JavaDoc insira a descrição da imagem aqui
Suragch
fonte
17

Você pode instalar o plug-in JavaDoc em Configurações-> Plugin-> Procurar repositórios.

obtenha a documentação do plugin no link abaixo

Documento do plugin JavaDoc

insira a descrição da imagem aqui

darwin
fonte
Isso funciona muito bem. Instale o plug-in JavaDoc (como acima) e pressione CNTL + SHIFT + ALT + G.
Alan Nelson
10

Você pode usar o estilo eclipse da geração de comentários JavaDoc através de "Corrigir comentário do documento". Abra "Preferências" -> "Mapa de teclas" e atribua a ação "Corrigir comentário do documento" a uma chave desejada.

Kohei Mikami
fonte
9

Aqui podemos algo como isto. E, em vez de usar qualquer atalho, podemos escrever comentários "padrão" no nível da classe / pacote / projeto. E modifique conforme a exigência

   *** 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.

A vantagem é que, você pode criar um bloco de comentários para all the methods at a time.

Mr.India
fonte
9

Os comentários do Javadoc podem ser anexados automaticamente usando o recurso de preenchimento automático do IDE. Tente digitar /**e pressionar Enterpara gerar um exemplo de comentário 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
 */
Kuldeep Kumar
fonte
5

No Android Studio, você não precisa do plug-in. Em um Mac, abra o Android Studio -> clique em Android Studio na barra superior -> clique em Prefrences -> encontre Modelos de arquivo e código na lista -> selecione inclui -> construa e será persistente em todo o seu projeto

Robert Warren
fonte
2
  • Outra maneira de adicionar o comentário de documentos java é pressionar: Ctrl + Shift + A >> mostrar um pop-up >> tipo: Adicionar javadocs >> Enter.

  • Ctrl + Camisa + A: Consulta de comando (nome do comando de preenchimento automático)

insira a descrição da imagem aqui

huu duy
fonte
2

Simplesmente selecione (ou seja, clique) no nome do método e, em seguida, use a combinação de teclas Alt + Enter, selecione "Adicionar JavaDoc"

Isso pressupõe que você ainda não adicionou comentários acima do método; caso contrário, a opção "Adicionar JavaDoc" não aparecerá.

Jim Robbins
fonte
2

No Android studio, temos algumas maneiras de gerar comentários automaticamente:

  • Método I:

Digitando / ** e, em seguida, pressionando Enter, você pode gerar a próxima linha de comentário e ela gerará automaticamente os parâmetros, etc. mas quando você precisar da tecla de atalho para este método de verificação II abaixo.

  • ** Método II: **

1 - Ir para o topoMenu

2 - Arquivo> Configurações

3 - Selecione Keymap nas configurações

4 - Na barra de pesquisa no canto superior direito, pesquise "Fix Doc"

5 - Selecione o "corrigir comentário do documento" nos resultados e clique duas vezes nele

6 - Selecione Adicionar atalho de teclado no menu suspenso aberto após clicar duas vezes.

7 - Pressione as teclas de atalho no teclado

8 - Vá para o seu código e, onde você deseja adicionar algum comentário, pressione a tecla de atalho

9 - Aproveite!

Noir
fonte
A maneira mais conveniente de adicionar documentos. Por exemplo, eu atribuí "" "e Enter como atalho
CodeToLife
1

Basta selecionar a versão Eclipse do keycap nas configurações de Keymap. Um Eclipse Keymap está incluído no Android Studio.

Brill Pappin
fonte
0

Não sei se entendi completamente a pergunta, mas uma lista de atalhos do teclado pode ser encontrada aqui - Espero que ajude!

fantasitcalbeastly
fonte
2
No eclipse para adicionar comentários javadoc pressione Alt + shift + j, mas em AndroidStudio mas eu não sei como fazer
qinxianyuzou
Se bem me lembro, esse atalho funcionou apenas se você tivesse o plugin 'jautodoc' instalado e ativado.
Matt
0

Android Studio -> Preferências -> Editor -> Intenções -> Java -> Declaração -> Ativar "Adicionar JavaDoc"

E, ao selecionar Métodos para implementar (Ctrl / Cmd + i), na parte inferior esquerda, você deverá ver a caixa de seleção para ativar a opção Copiar JavaDoc.

Mahi
fonte
0

Eu recomendei o Dokka para o javadoc com comentários e muito mais

Carma Yudi
fonte
-5

ALT+ SHIFT+ Gcriará os comentários gerados automaticamente para o seu método (coloque o cursor na posição inicial do seu método).

Dinesh IT
fonte
public void hideKeyboard () u deve colocar o cursor na frente do público e experimentá-lo ou verifique se instalou o documento java no seu estúdio.
Dinesh IT
Também não está funcionando para mim. Talvez esteja trabalhando em algum mapa de teclado especial. O mapa de teclas pode ser configurado em Preferências> Mapa de Chaves. Ou o mapa de teclas foi editado.
Oliver Kranz