Adicionando um cabeçalho de licença de direitos autorais para arquivos de origem Java no IntelliJ IDEA

Neste tutorial, veremos como adicionar um cabeçalho de licença aos arquivos de projeto do IntelliJ IDEA. O cabeçalho da licença geralmente descreve o uso permitido e a propriedade de um arquivo de projeto.

Presumimos que você tenha umbasic knowledge of IntelliJ, portanto, iremos direto ao ponto.

Vamos abrir qualquer um de nossos projetos existentes para configurar o cabeçalho da licença. Primeiro, precisamos acessar a janelaPreference clicando no item de menu IntelliJ IDEA ou pressionando as teclas Comando + Vírgula.

A nova janela pop-up exibirá uma lista de menus à esquerda, da qual podemos clicar emEditor>Copyright>Copyright Profiles. Para um acesso mais rápido, podemos simplesmente digitarCopyright na barra de pesquisa da janela Preferências.

No painel direito da janela, vamos clicar no botão “+” na parte superior para criar um novo Perfil de Copyright.

Começamos dando a ele um nome -MIT License, por exemplo—e clique em “OK”:

Depois disso, adicionaremos o texto da licença à área de texto.

Usamos um texto de exemplo que eventualmente deve ser substituído pelo nosso:

We replaced the <YEAR> with a placeholder – $today.year. Será traduzido automaticamente pelo IntelliJ para o ano atual toda vez que usarmos o perfil.

O IntelliJ define variáveis ​​adicionais que podemos usar em nosso perfil de direitos autorais. Para obter detalhes, reveja ohelp page.

Por fim, vamos clicar no botão “VALIDAR”, logo abaixo do texto da licença, para validar nosso texto e garantir que tudo está em ordem, e depois clicar em “APLICAR” para salvar o perfil.

O próximo passo é definir o perfil como padrão. Podemos fazer isso clicando emEditor>Copyrighte selecionando a Licença MIT como o copyright padrão do projeto:

Agora, é hora de usar o perfil de direitos autorais em nossos arquivos de projeto. Podemos conseguir isso pressionando as teclas Control + Return e selecionando o menu de direitos autorais:

Isso aplicará o texto de Copyright definido anteriormente como padrão na parte superior do arquivo do projeto.

Se talvez não estejamos satisfeitos com o formato do texto resultante, podemos ir paraPreferences>Editor>Copyright>Copyright Profiles para editá-lo e clicar em “APLICAR” . Depois disso, teremos que limpar o texto existente e pressionar as teclas Control + Return para aplicar o texto atualizado.

Posteriormente, qualquer novo arquivo de projeto que criarmos terá automaticamente o cabeçalho da licença, eliminando a necessidade de adicioná-lo manualmente.

Neste artigo rápido, aprendemos como configurar o IntelliJ IDEA para adicionar automaticamente cabeçalhos de licença a todos os arquivos de nosso projeto - o que pode ser bastante útil em bases de código maiores.