Incluindo cabeçalho de licença de direitos autorais para arquivos de origem Java no Eclipse

1. Visão geral

A adição de um cabeçalho de licença de direitos autorais para arquivos de origem no Eclipse IDE é conhecida por ser uma tarefa difícil e propensa a erros.

Neste tutorial, aprenderemos duas maneiras de tornar essa tarefa fácil e livre de erros. O primeiro usa o recurso Code Template do Eclipse IDE. O segundo usa o plugin do gerador de direitos autorais.

2. Usando o modelo de código

Primeiro, vamos ver como adicionar um cabeçalho de licença de direitos autorais usando o modelo de código. Vamos começar com a configuração do Eclipse:

2.1. Configuração do Eclipse

  • Na barra de menu principal, navegue atéPreferences

  • Em seguida, navegue paraJava → Code Style → Code Templates

  • Do lado direito da janela, expanda a seçãoCode e selecioneNew Java files

image

  • Então, vamos paraEdit Template clicando no botãoEdit

  • Na janelaEdit Template, adicionamos nosso cabeçalho de licença de direitos autorais na área de textoPattern

  • E, clique no botãoOK para atualizar o modelo

  • Finalmente, vamos clicar no botãoApply  para finalizar a configuração

image

Agora temos um cabeçalho de direitos autoraisautomatically applied to each new Java source file:

image

No entanto,this method has some disadvantages:

  • Não podemos usar isso para adicionar um cabeçalho de direitos autorais aos arquivos de origem existentes

  • Não podemos incluir variáveis ​​personalizadas no texto da licença, como o nome da empresa

  • Não é flexível o suficiente para permitir que escolhamos diferentes cabeçalhos de licença de direitos autorais

  • Podemos usar isso apenas em arquivos de origem Java e Javascript

Felizmente, existe uma alternativa na forma do plug-in gerador de direitos autorais.

Vamos começar configurando o plugin Copyright Generator.

3.1. Instalando o Plugin

  • Instalamos o plugin navegando paraHelp → Eclipse Marketplace

  • Em seguida, procuramos porEclipse Copyright Generator na caixa de textoFind

  • Por fim, vamos clicar no botãoInstall e seguir as instruções

image

Todos os cabeçalhos de licença de direitos autorais padrão são pré-instalados com o plug-in.

Mas e se quisermos adicionar um cabeçalho personalizado ou editar um? Vamos ver como fazer isso emCopyright Preferences:

  • Primeiro navegamos paraPreferences → General → Copyright

  • Então, para adicionar um novo cabeçalho de copyright, clicamos no botãoAdd

  • Para modificar uma licença existente, selecionamos uma licença emLicensese clicamos no botãoModify

image

Depois de instalar o plugin, é muito fácil aplicar um cabeçalho de licença de copyright a um ou mais arquivos de origem.

Vamos ver como aplicá-lo aos arquivos de origem selecionados:

  • No painelProject Explorer, selecionamos os arquivos de origem

  • Então,right-click nos arquivos de origem selecionados

  • No menu de contexto, selecionamos a opçãoApply copyright

[.s1] # Da mesma forma, para aplicar isso a um ou mais projetos: #

  • Na barra de menu principal, selecioneProject → Apply copyright

image

E então seguimos as instruções na caixa de diálogoApply copyright para adicionar o cabeçalho de direitos autorais aos arquivos:

  • Clicamos no botãoNext, que nos leva aoCopyright settings

image

  • Em seguida, selecione uma licença de direitos autorais na caixa de seleçãoCopyright type

image

  • E, clique no botãoNext , que nos leva à janela de arquivos

  • Finalmente, clicamos no botãoFinish  para aplicar o cabeçalho de copyright aos arquivos de origem selecionados

Agora, ao contrário do Code Template, o pluginwill not add a copyright header automatically on the creation of a new file.

No entanto, o plug-in temseveral advantages over the Code Template:

  • É fácil adicionar um cabeçalho de licença de direitos autorais para os arquivos de origem existentes

  • Podemos incluir variáveis ​​personalizadas no texto da licença, como o nome da empresa

  • O plugin suporta muitos cabeçalhos de licença de direitos autorais diferentes

  • Podemos adicionar um cabeçalho de direitos autorais a todos os tipos de arquivos de origem e não limitados aos arquivos de origem Java

4. Conclusão

[.s1] #Neste artigo, aprendemos duas maneiras diferentes de adicionar um cabeçalho de licença de direitos autorais aos nossos arquivos de origem. #

[.s1] #O pluginEclipse Copyright Generator é a maneira mais fácil e flexível de adicionar cabeçalhos de direitos autorais. #

A única desvantagem é que ele precisa ser aplicado depois que os arquivos são criados, onde o modelo de código adicionará um cabeçalho de copyright para nós quando cada arquivo for criado.