IDEA configura la plantilla de anotación del método de clase Java

1. Plantilla de anotaciones de clase

Archivo -> Configuración -> Editor -> Plantillas de archivos y códigos -> Archivos
seleccione Clase, Interfaz, Enum, etc., podemos ver que en el área derecha, encima de la clase pública, hay una línea #parse("Encabezado de archivo .Java")

imagen

Este código introduce el archivo File Header.java como un comentario para la interfaz de clase, Enum y otros archivos que creamos. Entonces, ¿dónde está esta clase? Podemos ver que en el lado derecho de Archivos, hay una opción Incluye. Aquí, Podemos definir varias plantillas e introducir esta plantilla cuando sea necesario. La plantilla File Header.java se ha introducido en el archivo de clase. Luego podemos cambiar esta plantilla a lo que queremos configurar.

imagen-20220512152855134

Plantilla de anotación personalizada

/**
 * @className: ${NAME}
 * @author: Kevin
 * @date:  ${DATE}
 **/

Los nuevos archivos de interfaz generan comentarios automáticamente, el efecto es el siguiente

/**
 * @className: CrowdService
 * @author: Kvein
 * @date: 2022年05月12日 15:33:00
 **/
public interface CrowdService {
    
    
}

Plantilla de anotación tabla de referencia de variables incompleta

Variables predefinidas Descripción
${NOMBRE} el nombre del archivo actual
${PACKAGE_NAME} nombre del paquete en el que se crea el nuevo archivo
${USUARIO} nombre de inicio de sesión del sistema de usuario actual
${FECHA} fecha actual del sistema
${HORA} hora actual del sistema
${AÑO} año corriente
${MES} mes actual
${MONTH_NAME_SHORT} primeras 3 letras del nombre del mes actual. Ejemplo: enero, febrero, etc.
${MONTH_NAME_FULL} nombre completo del mes actual. Ejemplo: enero, febrero, etc.
${DÍA} día actual del mes
${DAY_NAME_SHORT} primeras 3 letras del nombre del día actual. Ejemplo: lunes, martes, etc.
${DAY_NAME_FULL} nombre completo del día actual. Ejemplo: lunes, martes, etc.
${HORA} hora actual
${MINUTO} minuto actual
${PROJECT_NAME} el nombre del proyecto actual

2. Plantilla de anotación de método

Archivo -> Configuración -> Editor -> Plantillas activas

1. Haga clic en el signo + en el lado derecho de Live Templates para agregar un grupo de plantillas y asígnele el nombre métodoTemplates.

imagen

imagen

2. Cree plantillas en vivo según el método Plantillas que acaba de crear, de la siguiente manera

imagen

1) En la posición 1: Ingrese el código de abreviatura de la plantilla.
En la posición 2: Ingrese la descripción de la plantilla.
En la posición 3: Ingrese el estilo de la plantilla de comentario del método. Para variables variables, use el nombre de la variable.nombre de la variable a representar, como por ejemplo:param paramp a r a m ;
Si no está configurado con dicho nombre de variable, no se puede hacer clic en la posición 4. La plantilla es la siguiente:

/**
 * @title $title$
 * @author Kevin $param$
 * @updateTime $date$ $TIME$ $return$
 * @throws $throws$
 */

Haga clic en la posición 4: Puede editar el valor de la variable definida, de la siguiente manera:

imagen

La variable parámetro es la variable de parámetro del método, que debe cambiarse de acuerdo con el número de parámetros del método; la variable de retorno es el tipo de valor de retorno y también debe cambiarse de acuerdo con el valor de retorno del método. Por lo tanto, debe configurar el método usted mismo. El código de configuración es el siguiente, copie y pegue. Puede:

parámetro:

groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())

devolver :

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

En la Posición 3, haga clic para seleccionar el ámbito de aplicación de la plantilla. Seleccione En todas partes para indicar que la anotación se puede agregar en cualquier lugar.

imagen

Haga clic en Expandir con opciones para seleccionar las teclas de método abreviado utilizadas con esta plantilla, como la tecla Tab, la tecla Espacio, la tecla Intro, etc.;

Por ejemplo, si la palabra clave de plantilla establecida aquí es * y la tecla de acceso directo utilizada es la tecla Tab
, ingrese * en el método y presione la tecla Tab para generar comentarios de acuerdo con la plantilla.

imagen-20220512154405338

Información adicional

La plantilla de anotación del método no se puede usar fuera del método. Si se usa fuera del método, no se puede obtener @param y la anotación será @param nula;

La plantilla de anotación de clase se genera cuando se crea el archivo. El archivo creado no activará la plantilla, pero sí la plantilla de anotación de método.

Supongo que te gusta

Origin blog.csdn.net/weixin_52173254/article/details/124733010
Recomendado
Clasificación