Koptekst copyrightlicentie toevoegen voor Java-bronbestanden in Eclipse

1. Overzicht

Het is bekend dat het toevoegen van een copyrightlicentiekop voor bronbestanden in de Eclipse IDE een moeilijke en foutgevoelige taak is.

In deze zelfstudie leren we twee manieren om deze taak eenvoudig en foutloos te maken. De eerste gebruikt de codesjabloonfunctie van de Eclipse IDE. De tweede maakt gebruik van de Copyright Generator Plugin.

2. Met behulp van de codesjabloon

Laten we eerst eens kijken hoe u een copyrightlicentiekop kunt toevoegen met behulp van de codesjabloon. Laten we beginnen met de Eclipse-configuratie:

2.1. Eclipse-instellingen

  • Navigeer in de hoofdmenubalk naar Voorkeuren
  • Navigeer vervolgens naar Java -> Codestijl -> Codesjablonen
  • Vouw vanaf de rechterkant van het venster het Code sectie en selecteer Nieuwe Java-bestanden
  • Dan gaan we naar Sjabloon bewerken door op het Bewerk knop
  • In de Sjabloon bewerken -venster, voegen we onze kop van de copyrightlicentie toe aan het Patroon tekstgebied
  • En klik op het OK knop om de sjabloon bij te werken
  • Laten we ten slotte op het Van toepassing zijn knop om de installatie te voltooien

2.2. Copyright toepassen

We krijgen nu een copyright-header automatisch toegepast op elk nieuw Java-bronbestand:

Echter, deze methode heeft enkele nadelen:

  • We kunnen dit niet gebruiken om een ​​copyright-header toe te voegen aan bestaande bronbestanden
  • We kunnen geen aangepaste variabelen in de licentietekst opnemen, zoals onze bedrijfsnaam
  • Het is niet flexibel genoeg om ons verschillende kopteksten voor copyrightlicenties te laten kiezen
  • We kunnen dit alleen gebruiken voor Java- en Javascript-bronbestanden

Gelukkig is er een alternatief in de vorm van de plug-in voor het genereren van auteursrechten.

3. De plug-in Copyright Generator gebruiken

Laten we beginnen met het instellen van de plug-in Copyright Generator.

3.1. De plug-in installeren

  • We installeren de plug-in door naar Help -> Eclipse Marketplace
  • Dan zoeken we naar Eclipse Copyright Generator in de Vind tekstvak
  • Laten we ten slotte op het Installeren knop en volg de instructies

3.2. Kopteksten voor copyrightlicenties aanpassen

Alle standaard headers voor copyrightlicenties zijn vooraf geïnstalleerd met de plug-in.

Maar wat als we een aangepaste koptekst willen toevoegen of er een willen bewerken? Laten we eens kijken hoe we dat moeten doen Copyright-voorkeuren:

  • We navigeren eerst naar Voorkeuren -> Algemeen -> Copyright
  • Om vervolgens een nieuwe copyright-header toe te voegen, klikken we op de Toevoegen knop
  • Om een ​​bestaande licentie te wijzigen, selecteren we een licentie uit de Licenties en klik vervolgens op het Aanpassen knop

3.3. Copyright toepassen

Na het installeren van de plug-in is het vrij eenvoudig om een ​​copyright-licentiekop toe te passen op een of meer bronbestanden.

Laten we eens kijken hoe we het op de geselecteerde bronbestanden kunnen toepassen:

  • Van de Projectverkenner paneel, selecteren we de bronbestanden
  • Dan, klik met de rechtermuisknop op de geselecteerde bronbestanden
  • In het contextmenu selecteren we de Pas copyright toe keuze

Evenzo om dit toe te passen op een of meer projecten:

  • Selecteer in de hoofdmenubalk Project -> Copyright toepassen

En dan volgen we de instructie in het Pas copyright toe dialoogvenster om de copyright-header aan de bestanden toe te voegen:

  • We klikken op de De volgende knop, die ons naar de Copyright-instellingen
  • Selecteer vervolgens een copyrightlicentie in het Copyright-type selecteer box
  • En klik op het De volgende knop, die ons naar het bestandenvenster brengt
  • Ten slotte klikken we op het Af hebben om de copyright-header toe te passen op de geselecteerde bronbestanden

Nu in tegenstelling tot codesjabloon, de plug-in zal niet automatisch een copyright-header toevoegen bij het maken van een nieuw bestand.

De plug-in heeft echter verschillende voordelen ten opzichte van de codesjabloon:

  • Het is gemakkelijk om een ​​copyright-licentiekop toe te voegen voor de bestaande bronbestanden
  • We kunnen aangepaste variabelen opnemen in de licentietekst, zoals de bedrijfsnaam
  • De plug-in ondersteunt veel verschillende koppen van copyrightlicenties
  • We kunnen een copyright-header toevoegen aan alle soorten bronbestanden en niet beperkt tot Java-bronbestanden

4. Conclusie

In dit artikel hebben we twee verschillende manieren geleerd om een ​​copyrightlicentiekop toe te voegen aan onze bronbestanden.

De Eclipse Copyright Generator plug-in is de gemakkelijkste en meest flexibele manier om copyrightheaders toe te voegen.

Het enige nadeel is dat het moet worden toegepast nadat de bestanden zijn gemaakt, waarbij de codesjabloon een copyright-header voor ons zal toevoegen wanneer elk bestand wordt gemaakt.