que - Cómo generar comentarios de javadoc en Android Studio
android javadoc (13)
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:
¿Puedo usar teclas de método abreviado en Android studio para generar comentarios de javadoc?
Si no, ¿cuál es la forma más fácil de generar comentarios de javadoc?
Aquí podemos algo como esto. Y en lugar de usar cualquier atajo, podemos escribir comentarios "predeterminados" a nivel de clase / paquete / proyecto. Y modificar según el requisito
*** 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 puedes crear bloques de comentarios para all the methods at a time.
En Android Studio no necesitas el complemento. En Mac, simplemente abre Android Studio -> haz clic en Android Studio en la barra superior -> haz clic en Prefrences -> busca Plantillas de archivos y códigos en la lista -> selecciona includes -> build it y será persistente en todo su proyecto
En el estudio de Android, tenemos pocas formas de generar comentarios de forma automática:
- Método I:
Al escribir / ** y luego al presionar Enter, puede generar la siguiente línea de comentarios y generará automáticamente los parámetros, etc., pero cuando necesite la tecla de acceso directo para este método de verificación II a continuación.
- ** Método II: **
1 - Ir arribaMenu
2 - Archivo> Configuración
3 - Seleccione Keymap desde la configuración
4 - En la barra de búsqueda superior derecha busque "Fix Doc"
5 - Seleccione el "comentario del documento de reparación" 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 método abreviado en el teclado
8 - Vaya a su código y donde quiera agregar algún comentario presione la tecla de método abreviado
9 - ¡Disfruta!
No estoy seguro de entender por completo la pregunta, pero here puede encontrar una lista de atajos de teclado. ¡Espero que esto ayude!
Para generar comentarios, escriba /** key 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 this
Puede instalar el complemento JavaDoc desde Configuración-> Complemento-> Buscar repositorios.
obtener la documentación del complemento desde el siguiente enlace
Puede usar el estilo de eclipse de la generación de comentarios de JavaDoc mediante "Fix doc comment". Abra "Preference" -> "Keymap" y asigne la acción "Fix doc comment" a la tecla que desee.
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 no ha agregado comentarios sobre el método, de lo contrario, la opción "Agregar JavaDoc" no aparecerá.
Simplemente seleccione la versión de Eclipse de la tecla en la configuración de Keymap. Un mapa de teclas de Eclipse está incluido en Android Studio.
ALT + SHIFT + G creará los comentarios generados automáticamente para su método (coloque el cursor en la posición inicial de su método).
No puedo encontrar ningún atajo para generar comentarios de 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 this para más información.
