Cómo generar comentarios también al generar automáticamente getters y setters en Android Studio
Quiero generar comentarios también al generar automáticamente getters y setters
Android Studio:
- Oyente de red Android
- Uso de Socket.IO en Android siempre devuelve error de sondeo XHR
- Error de c2dm 401 al enviar mensajes después de recibir id y token de autenticación
- Cambiar la configuración regional en el emulador de Android
- Arrastrar y soltar en un `ListView`
/** * username */ private String name; public String getName() { return name; }
Yo quiero:
/** * username */ private String name; /** * Get username * @return username */ public String getName() { return name; }
- Android: Errores de archivo IO
- Colección con eliminación rápida / iteración / inserción que recicla objetos en los programas de Android / Java?
- Abra la aplicación para Android cuando la conexión a Internet esté activada, de lo contrario no mostrará ningún mensaje de conexión a Internet
- No se puede generar clave en el almacén de claves de Android
- Android Drawer Layout está mostrando contenido de fragmentos
- Agregar sombra al ShapeDrawable mediante programación
- Android setOnclicklistener parámetro
- Cómo usar el valor automático con firebase 9.2 en Android
La capacidad de crear plantillas personalizadas setter & getter se agregó en IntelliJ IDEA v14.1 (específicamente construir 141.177) a través de la solicitud de característica IDEA-28206 Permitir la personalización de getter / setter generado . No sé si ese cambio se ha fusionado en la rama de Android Studio todavía.
Con la función (nueva), al activar la intención getter / setter de inserción, el cuadro de diálogo le permite seleccionar la plantilla a utilizar:
Puede hacer clic en el botón Examinar Para crear una nueva plantilla. Utiliza el lenguaje de plantilla Velocity. Puede crear una plantilla que incluya los comentarios deseados. En el boleto, alguien ha publicado su setter personalizado . El ticket para documentar la función aún está pendiente.
Por último, hay una solicitud de característica abierta ( IDEABKL-4910 Javadocs para getters / setters ) para que Javadocs se incluya automáticamente al generar setters y getters. Sin embargo, esto está en el backlog y ahora que IDEA-28206 ha sido implementado, dudo que esto consiga alguna atención.
Sé que la respuesta ya ha sido aceptada para este post, pero me encontré con el mismo problema y aunque voy a darle un tiro también.
Como Mark le explicó cómo create you own custom settings on the getters and setters options,
traté de usar la Intellij's settings
para getters
y setters
y personalizarlo de la manera que quiero ser.
Así es como se ve la Getter Template para mí:
/** *@return Gets the value of $field.name and returns $field.name */ public ## #if($field.modifierStatic) static ## #end $field.type ## #set($name = $StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))) #if ($field.boolean && $field.primitive) #if ($StringUtil.startsWithIgnoreCase($name, 'is')) #set($name = $StringUtil.decapitalize($name)) #else is## #end #else get## #end ${name}() { return $field.name; }
Para la explicación, utilicé el $field.name
como valor del comentario y $field.name
una estructura regular del comentario para poner el valor antes de que comience la generación del método.
P.ej :
/** *@return Gets the value of $field.name and returns $field.name */
Así es como se ve mi Plantilla Setter:
/** * Sets the $field.name You can use get$StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))() to get the value of $field.name */ #set($paramName = $helper.getParamName($field, $project)) public ## #if($field.modifierStatic) static ## #end void set$StringUtil.capitalizeWithJavaBeanConvention($StringUtil.sanitizeJavaIdentifier($helper.getPropertyName($field, $project)))($field.type $paramName) { #if ($field.name == $paramName) #if (!$field.modifierStatic) this.## #else $classname.## #end #end $field.name = $paramName; }
Y el valor de $field.name
es el mismo que el del getter. Siempre puede personalizar la estructura de comentarios de esta manera y puede utilizar otros atributos como $classname.##
también si es necesario.
Este fue sólo un pequeño ejemplo de cómo hice mis comments enabling in Android Studio when doing a generate getters and setters for the the fields.
Espero que esto ayude a alguien en el futuro. Buena suerte.
Creo que esto no es posible en java pero puedes cambiar las plantillas de comentario / código siguiendo los pasos.
- Crear una clase con un campo
- Haga clic en Alt + Mayús + S
- Seleccione la opción Generate Getters and Setters ..
- Seleccione la casilla de verificación del campo que creó
- Encuentre las plantillas de código de enlace en la parte inferior del cuadro de diálogo y haga clic en eso.
- Ahora puede habilitar la opción de configuración específica del proyecto y cambiar las plantillas de comentarios / código que desee.
- Haga clic en aplicar y aceptar
- Seleccione la opción Generar comentarios de métodos y haga clic en Aceptar. Ahora el getter y setter se creará con comentarios según los cambios de su plantilla.
Por favor, intente obtener el archivo de su idea con el uso de los comentarios anteriores.
No es compatible con Android Studio (al menos en la versión 1.2).
Puede descargar un complemento ( Preferencias / Plugins ), por ejemplo, JavaDoc, que añade opciones adicionales en el menú "Generar …" y le permite generar comentarios javadoc para todos los campos / métodos seleccionados
- ¿Cómo obtener una notificación en la esquina del icono del programa?
- Travis CI skip pruebas (Gradle Android proyecto)