Cómo generar comentarios javadoc en Android Studio

¿Puedo usar teclas de acceso directo en el estudio de Android para generar comentarios de javadoc?

Si no, ¿cuál es la forma más fácil de generar comentarios javadoc?

No puedo encontrar ningún acceso directo para generar comentarios javadoc. Pero si escribe /**antes de la declaración del método y presiona Enter, el bloque de comentarios javadoc se generará automáticamente.

Lea esto para más información.

Para generar comentarios, escriba la /**tecla antes de la declaración del método y presione Enter. Generará el comentario de javadoc.

Ejemplo:

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

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

Para obtener más información, consulte el enlace https://www.jetbrains.com/idea/features/javadoc.html

Aquí hay un ejemplo de un comentario JavaDoc de 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;
        }
 }

El formato básico se puede generar automáticamente de cualquiera de las siguientes maneras:

• Coloque el cursor sobre el método y escriba /**+Enter
• Coloque el cursor sobre el nombre del método y presione Alt+ Enter> haga clic en Agregar JavaDoc

Puede instalar el complemento JavaDoc desde Configuración-> Complemento-> Examinar repositorios.

obtener documentación del complemento desde el siguiente enlace

Documento de complemento JavaDoc

Puede usar el estilo eclipse de generación de comentarios JavaDoc a través de "Fix doc comment". Abra "Preferencia" -> "Mapa de teclas" y asigne la acción "Reparar comentario de documento" a la tecla que desee.

Aquí podemos hacer algo como esto. Y en lugar de usar cualquier atajo, podemos escribir comentarios "predeterminados" a nivel de clase / paquete / proyecto. Y modificar según requerimiento

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

La ventaja es que puede crear un bloque de comentarios para all the methods at a time.

Los comentarios de Javadoc se pueden agregar automáticamente mediante el uso de la función de autocompletar de su IDE. Intente escribir /**y golpear Enterpara generar un comentario Javadoc de muestra.

 /**
 *
 * @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
 */

En Android Studio no necesita el complemento. En una Mac, simplemente abra Android Studio -> haga clic en Android Studio en la barra superior -> haga clic en Preferencias -> busque plantillas de archivos y códigos en la lista -> seleccione incluye -> compílelo y será persistente en todo su proyecto

• Otra forma de agregar comentarios de java docs es presionar: Ctrl + Shift + A >> mostrar una ventana emergente >> tipo: Agregar javadocs >> Enter.

• Ctrl + Camisa + A: búsqueda de comandos (nombre del comando de autocompletar)

Simplemente seleccione (es decir, haga clic) el nombre del método, luego use la combinación de teclas Alt + Intro, seleccione "Agregar JavaDoc"

Esto supone que aún no ha agregado comentarios sobre el método; de lo contrario, la opción "Agregar JavaDoc" no aparecerá.

En Android Studio tenemos pocas formas de generar comentarios automáticamente:

• Método I:

Al escribir / ** y luego presionar Intro, puede generar la siguiente línea de comentarios y generará automáticamente los parámetros, etc. pero cuando necesite la tecla de acceso rápido para este método de verificación II a continuación.

• ** Método II: **

1 - Ir a topMenu

2 - Archivo> Configuración

3 - Seleccione Keymap de la configuración

4 - En la barra de búsqueda superior derecha, busque "Fix Doc"

5 - Seleccione el "arreglo del comentario del documento" de los resultados y haga doble clic en él

6 - Seleccione Agregar atajo de teclado del menú desplegable abierto después de hacer doble clic

7 - Presione las teclas de acceso directo en el teclado

8 - Pase a su código y dónde desea agregar algún comentario presione la tecla de acceso directo

9 - ¡Disfruta!

Simplemente seleccione la versión Eclipse de la tecla en la configuración de Keymap. Se incluye un mapa de teclas de Eclipse en Android Studio.

No estoy seguro de entender completamente la pregunta, pero aquí se puede encontrar una lista de atajos de teclado . ¡Espero que esto ayude!

Android Studio -> Preferencias -> Editor -> Intenciones -> Java -> Declaración -> Habilitar "Agregar JavaDoc"

Y, mientras selecciona Métodos para implementar (Ctrl / Cmd + i), en la parte inferior izquierda, debería ver la casilla de verificación para habilitar Copiar JavaDoc.

Yo recomendé a Dokka para generar Javadoc con comentarios y más

ALT+ SHIFT+ Gcreará los comentarios generados automáticamente para su método (coloque el cursor en la posición inicial de su método).