IDEA configura modelo de anotação de método de classe Java

1. Modelo de anotação de classe

Arquivo -> Configurações -> Editor -> Modelos de Arquivo e Código -> Arquivos
selecione Classe, Interface, Enum, etc., podemos ver que na área direita, acima da classe pública, existe uma linha #parse("File Header .Java")

Este código introduz o arquivo File Header.java como um comentário para a Interface de Classe, Enum e outros arquivos que criamos. Então, onde está essa classe? Podemos ver que no lado direito de Arquivos, há uma opção Inclui. Aqui, nós podemos definir vários modelos e introduzir este modelo quando necessário. O modelo File Header.java foi introduzido no arquivo de classe. Em seguida, podemos alterar este modelo para o que desejamos configurá-lo.

Modelo de anotação personalizado

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

Novos arquivos de interface geram comentários automaticamente, o efeito é o seguinte

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

Tabela de referência de variável incompleta do modelo de anotação

Variáveis ​​predefinidas	Descrição
${NOME}	o nome do arquivo atual
${PACKAGE_NAME}	nome do pacote no qual o novo arquivo é criado
${USUÁRIO}	nome de login do sistema do usuário atual
${DATA}	data atual do sistema
${TIME}	hora atual do sistema
${ANO}	ano atual
${MÊS}	mês atual
${MONTH_NAME_SHORT}	primeiras 3 letras do nome do mês atual. Exemplo: janeiro, fevereiro, etc.
${MONTH_NAME_FULL}	nome completo do mês atual. Exemplo: janeiro, fevereiro, etc.
${DIA}	dia atual do mês
${DAY_NAME_SHORT}	primeiras 3 letras do nome do dia atual. Exemplo: segunda, terça, etc.
${DAY_NAME_FULL}	nome completo do dia atual. Exemplo: segunda, terça, etc.
${HORA}	hora atual
${MINUTE}	minuto atual
${PROJECT_NAME}	o nome do projeto atual

2. Modelo de anotação de método

Arquivo -> Configurações -> Editor -> Modelos ativos

1. Clique no sinal + no lado direito de Live Templates para adicionar um grupo de modelos e nomeie-o como methodTemplates

2. Crie Live Templates sob os methodTemplates recém-criados, como segue

1) Na posição 1: Insira o código de abreviação do modelo.
Na posição 2: Insira a descrição do modelo.
Na posição 3: Insira o estilo do modelo de comentário do método. Para variáveis ​​variáveis, use $nomeda\; variável$ a ser representada, como:$param$ ;
Se não estiver definido com esse nome de variável, a posição 4 não poderá ser clicada. O modelo é o seguinte:

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

Clique na posição 4: Você pode editar o valor da variável definida, da seguinte forma:

A variável param é a variável de parâmetro do método, que precisa ser alterada de acordo com o número de parâmetros do método; a variável return é o tipo de valor de retorno e também precisa ser alterada de acordo com o valor de retorno do método, então você mesmo precisa definir o método. O código de configuração é o seguinte, copie e cole. Pode:

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())

retornar :

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())

Na Posição 3, clique para selecionar o escopo de aplicação do modelo. Selecione Em todos os lugares para indicar que a anotação pode ser adicionada em qualquer lugar.

Clique em Expandir com nas opções para selecionar as teclas de atalho usadas com este modelo, como tecla Tab, tecla Espaço, tecla Enter, etc.;

Por exemplo, se a palavra-chave do modelo definida aqui for * e a tecla de atalho usada for a tecla Tab
, insira * no método e pressione a tecla Tab para gerar comentários de acordo com o modelo.

Informações adicionais

O modelo de anotação do método não pode ser usado fora do método. Se for usado fora do método, @param não poderá ser obtido e a anotação será @param null;

O modelo de anotação de classe é gerado quando o arquivo é criado. O arquivo criado não acionará o modelo, mas o modelo de anotação de método será acionado.