Hinzufügen eines Copyright-Lizenzheaders für Java-Quelldateien in Eclipse

1. Übersicht

Das Hinzufügen eines Copyright-Lizenz-Headers für Quelldateien in der Eclipse-IDE ist bekanntermaßen eine schwierige und fehleranfällige Aufgabe.

In diesem Tutorial lernen wir zwei Möglichkeiten, um diese Aufgabe einfach und fehlerfrei zu gestalten. Der erste verwendet die Codevorlagenfunktion der Eclipse IDE. Der zweite verwendet das Copyright Generator Plugin.

2. Verwenden der Codevorlage

Lassen Sie uns zunächst sehen, wie Sie mithilfe der Codevorlage einen Copyright-Lizenzheader hinzufügen. Beginnen wir mit dem Eclipse-Setup:

2.1. Eclipse-Setup

  • Navigieren Sie in der Hauptmenüleiste zu Einstellungen
  • Navigieren Sie dann zu Java -> Codestil -> Codevorlagen
  • Erweitern Sie auf der rechten Seite des Fensters den Abschnitt Code und wählen Sie Neue Java-Dateien aus
  • Dann gehen wir auf Vorlage bearbeiten , indem Sie auf den Bearbeiten - Taste
  • Im Fenster Vorlage bearbeiten fügen wir unseren Copyright-Lizenzheader im Textbereich Muster hinzu
  • Klicken Sie auf die Schaltfläche OK , um die Vorlage zu aktualisieren
  • Klicken Sie abschließend auf die Schaltfläche Übernehmen , um die Einrichtung abzuschließen

2.2. Urheberrecht anwenden

Wir erhalten jetzt einen Copyright-Header, der automatisch auf jede neue Java-Quelldatei angewendet wird :

Allerdings hat dieses Verfahren einige Nachteile :

  • Wir können dies nicht verwenden, um vorhandenen Quelldateien einen Copyright-Header hinzuzufügen
  • Wir können keine benutzerdefinierten Variablen wie unseren Firmennamen in den Lizenztext aufnehmen
  • Es ist nicht flexibel genug, um verschiedene Copyright-Lizenz-Header auswählen zu können
  • Wir können dies nur für Java- und Javascript-Quelldateien verwenden

Zum Glück gibt es eine Alternative in Form des Copyright Generator Plugins.

3. Verwenden des Copyright Generator Plugins

Beginnen wir mit dem Einrichten des Copyright Generator-Plugins.

3.1. Plugin installieren

  • Wir installieren das Plugin, indem wir zu Hilfe -> Eclipse Marketplace navigieren
  • Dann suchen wir für Eclipse - Urheberrecht Generator im Suche Textfeld
  • Klicken Sie abschließend auf die Schaltfläche Installieren und befolgen Sie die Anweisungen

3.2. Anpassen von Copyright-Lizenz-Headern

Alle Standard-Copyright-Lizenz-Header sind mit dem Plugin vorinstalliert.

Aber was ist, wenn wir einen benutzerdefinierten Header hinzufügen oder einen bearbeiten möchten? Sehen wir uns in den Copyright-Einstellungen an, wie das geht :

  • Wir navigieren zuerst zu Einstellungen -> Allgemein -> Urheberrecht
  • Um einen neuen Copyright-Header hinzuzufügen, klicken wir auf die Schaltfläche Hinzufügen
  • Um eine bestehende Lizenz zu ändern, wählen wir eine Lizenz aus den Lizenzen und dann klicken Sie auf die Ändern Schaltfläche

3.3. Urheberrecht anwenden

Nach der Installation des Plugins ist das Anwenden eines Copyright-Lizenz-Headers auf eine oder mehrere Quelldateien recht einfach.

Mal sehen, wie man es auf die ausgewählten Quelldateien anwendet:

  • Im Projekt-Explorer-Bereich wählen wir die Quelldateien aus
  • Klicken Sie dann mit der rechten Maustaste auf die ausgewählten Quelldateien
  • Im Kontextmenü wählen wir die Option Copyright anwenden

Um dies auf ein oder mehrere Projekte anzuwenden:

  • Wählen Sie in der Hauptmenüleiste Projekt -> Copyright anwenden

Befolgen Sie dann die Anweisungen im Dialogfeld Urheberrecht anwenden , um den Dateien den Copyright-Header hinzuzufügen:

  • Wir klicken auf die Schaltfläche Weiter , um zu den Copyright-Einstellungen zu gelangen
  • Wählen Sie dann eine Copyright-Lizenz aus dem Auswahlfeld Copyright-Typ aus
  • Klicken Sie auf die Schaltfläche Weiter , um zum Dateifenster zu gelangen
  • Schließlich klicken wir auf die Schaltfläche Fertig stellen , um den Copyright-Header auf die ausgewählten Quelldateien anzuwenden

Im Gegensatz zur Codevorlage fügt das Plugin beim Erstellen einer neuen Datei nicht automatisch einen Copyright-Header hinzu .

Das Plugin bietet jedoch mehrere Vorteile gegenüber der Codevorlage :

  • Es ist einfach, einen Copyright-Lizenzheader für die vorhandenen Quelldateien hinzuzufügen
  • Wir können benutzerdefinierte Variablen in den Lizenztext aufnehmen, z. B. den Firmennamen
  • Das Plugin unterstützt viele verschiedene Copyright-Lizenz-Header
  • Wir können allen Arten von Quelldateien einen Copyright-Header hinzufügen, der nicht auf Java-Quelldateien beschränkt ist

4. Fazit

In diesem Artikel haben wir zwei verschiedene Möglichkeiten kennengelernt, wie Sie unseren Quelldateien einen Copyright-Lizenzheader hinzufügen können.

Das Eclipse Copyright Generator- Plugin ist die einfachste und flexibelste Möglichkeit, Copyright-Header hinzuzufügen.

Der einzige Nachteil ist, dass es nach dem Erstellen der Dateien angewendet werden muss, wobei die Codevorlage beim Erstellen jeder Datei einen Copyright-Header für uns hinzufügt.