Aggiunta dell'intestazione della licenza di copyright per i file di origine Java in Eclipse

1. Panoramica

L'aggiunta di un'intestazione di licenza di copyright per i file di origine nell'IDE di Eclipse è nota per essere un'attività difficile e soggetta a errori.

In questo tutorial impareremo due modi per rendere questa attività facile e priva di errori. Il primo utilizza la funzione Modello di codice dell'IDE di Eclipse. Il secondo utilizza il plug-in Generatore di copyright.

2. Utilizzo del modello di codice

Per prima cosa, vediamo come aggiungere un'intestazione di licenza di copyright utilizzando il modello di codice. Cominciamo con la configurazione di Eclipse:

2.1. Configurazione di Eclipse

  • Dalla barra del menu principale, vai a Preferenze
  • Quindi, vai a Java -> Stile codice -> Modelli di codice
  • Dal lato destro della finestra, espandere la sezione Codice e selezionare Nuovi file Java
  • Quindi, andiamo a Modifica modello facendo clic sul pulsante Modifica
  • Nella finestra Modifica modello , aggiungiamo la nostra intestazione della licenza di copyright nell'area di testo Motivo
  • E fai clic sul pulsante OK per aggiornare il modello
  • Infine, facciamo clic sul pulsante Applica per terminare la configurazione

2.2. Applicazione del copyright

Ora otteniamo un'intestazione del copyright applicata automaticamente a ogni nuovo file sorgente Java :

Tuttavia, questo metodo presenta alcuni svantaggi :

  • Non possiamo usarlo per aggiungere un'intestazione di copyright a file sorgente esistenti
  • Non possiamo includere variabili personalizzate nel testo della licenza, come il nome della nostra azienda
  • Non è abbastanza flessibile da permetterci di scegliere diverse intestazioni di licenza di copyright
  • Possiamo usarlo solo su file sorgente Java e Javascript

Fortunatamente, esiste un'alternativa sotto forma di plug-in per il generatore di copyright.

3. Utilizzo del plug-in Generatore di copyright

Iniziamo impostando il plug-in Generatore di copyright.

3.1. Installazione del plugin

  • Installiamo il plug-in navigando su Aiuto -> Eclipse Marketplace
  • Quindi cerchiamo Eclipse Copyright Generator nella casella di testo Trova
  • Infine, facciamo clic sul pulsante Installa e seguiamo le istruzioni

3.2. Personalizzazione delle intestazioni delle licenze di copyright

Tutte le intestazioni delle licenze di copyright standard sono preinstallate con il plug-in.

Ma cosa succede se vogliamo aggiungere un'intestazione personalizzata o modificarne una? Vediamo come farlo nelle Preferenze del copyright :

  • Per prima cosa andiamo su Preferenze -> Generali -> Copyright
  • Quindi, per aggiungere una nuova intestazione di copyright, facciamo clic sul pulsante Aggiungi
  • Per modificare una licenza esistente, selezioniamo una licenza dalle Licenze e quindi fare clic sul pulsante Modifica

3.3. Applicazione del copyright

Dopo aver installato il plug-in, applicare un'intestazione di licenza di copyright a uno o più file sorgente è abbastanza semplice.

Vediamo come applicarlo sui file sorgente selezionati:

  • Dal pannello Project Explorer , selezioniamo i file di origine
  • Quindi, fare clic con il pulsante destro del mouse sui file di origine selezionati
  • Dal menu contestuale, selezioniamo l' opzione Applica copyright

Allo stesso modo, per applicarlo a uno o più progetti:

  • Dalla barra dei menu principale, seleziona Progetto -> Applica copyright

Quindi seguiamo le istruzioni nella finestra di dialogo Applica copyright per aggiungere l'intestazione del copyright ai file:

  • Facciamo clic sul pulsante Avanti , che ci porta alle impostazioni del copyright
  • Quindi, seleziona una licenza di copyright dalla casella di selezione Tipo di copyright
  • E fai clic sul pulsante Avanti , che ci porta alla finestra dei file
  • Infine, facciamo clic sul pulsante Fine per applicare l'intestazione del copyright ai file di origine selezionati

Ora, a differenza del modello di codice, il plug- in non aggiungerà automaticamente un'intestazione del copyright alla creazione di un nuovo file .

Tuttavia, il plugin ha diversi vantaggi rispetto al modello di codice :

  • È facile aggiungere un'intestazione di licenza di copyright per i file sorgente esistenti
  • Possiamo includere variabili personalizzate nel testo della licenza, come il nome dell'azienda
  • Il plugin supporta molte diverse intestazioni di licenza di copyright
  • Possiamo aggiungere un'intestazione del copyright a tutti i tipi di file sorgente e non limitati ai file sorgente Java

4. Conclusione

In questo articolo, abbiamo imparato due modi diversi per aggiungere un'intestazione di licenza di copyright ai nostri file sorgente.

Il plug-in Eclipse Copyright Generator è il modo più semplice e flessibile per aggiungere intestazioni di copyright.

L'unico svantaggio è che deve essere applicato dopo la creazione dei file, dove il modello di codice aggiungerà un'intestazione di copyright per noi quando ogni file viene creato.