Tilføjelse af copyrightlicensoverskrift til Java-kildefiler i formørkelse

1. Oversigt

Tilføjelse af en copyrightlicensoverskrift til kildefiler i Eclipse IDE er kendt for at være en vanskelig og fejlbehæftet opgave.

I denne vejledning lærer vi to måder at gøre denne opgave nem og fejlfri. Den første bruger Eclipse IDE's Code Template-funktion. Den anden bruger Copyright Generator Plugin.

2. Brug af kodeskabelonen

Lad os først se, hvordan du tilføjer en copyrightlicensoverskrift ved hjælp af kodeskabelonen. Lad os begynde med Eclipse-opsætningen:

2.1. Formørkelse af formørkelse

  • Gå til hovedmenulinjen Præferencer
  • Naviger derefter til Java -> Kodestil -> Kodeskabeloner
  • Udvid vinduet fra højre side af vinduet Kode sektion og vælg Nye Java-filer
  • Så går vi til Rediger skabelon ved at klikke på Redigere knap
  • I Rediger skabelon vindue tilføjer vi vores copyrightlicensoverskrift i Mønster tekstområde
  • Og klik på Okay knap for at opdatere skabelonen
  • Lad os endelig klikke på ansøge for at afslutte opsætningen

2.2. Anvendelse af ophavsret

Vi får nu en copyright-overskrift anvendes automatisk til hver nye Java-kildefil:

Imidlertid, denne metode har nogle ulemper:

  • Vi kan ikke bruge dette til at tilføje en copyright-overskrift til eksisterende kildefiler
  • Vi kan ikke medtage brugerdefinerede variabler i licensteksten som vores virksomhedsnavn
  • Det er ikke fleksibelt nok til, at vi kan vælge forskellige copyrightlicensoverskrifter
  • Vi kan kun bruge dette på Java- og Javascript-kildefiler

Heldigvis er der et alternativ i form af plugin til copyrightgenerator.

3. Brug af plugin til ophavsretgenerator

Lad os starte med at konfigurere Copyright Generator-pluginet.

3.1. Installation af pluginet

  • Vi installerer pluginet ved at navigere til Hjælp -> Eclipse Marketplace
  • Så søger vi efter Eclipse Generator for ophavsret i Finde tekstboks
  • Lad os endelig klikke på Installere og følg instruktionerne

3.2. Tilpasning af copyrightlicensoverskrifter

Alle standard copyrightlicensoverskrifter er forudinstalleret med pluginet.

Men hvad hvis vi vil tilføje en brugerdefineret overskrift eller redigere en? Lad os se, hvordan man gør det i Copyright præferencer:

  • Vi navigerer først til Præferencer -> Generelt -> Ophavsret
  • Derefter, for at tilføje et nyt copyright-overskrift, skal vi klikke på Tilføje knap
  • For at ændre en eksisterende licens vælger vi en licens fra Licenser og klik derefter på Modificere knap

3.3. Anvendelse af ophavsret

Efter installation af pluginet er det ret nemt at anvende en copyrightlicensoverskrift på en eller flere kildefiler.

Lad os se, hvordan du anvender det på de valgte kildefiler:

  • Fra Project Explorer panel vælger vi kildefilerne
  • Derefter, Højreklik på de valgte kildefiler
  • Fra genvejsmenuen vælger vi Anvend copyright mulighed

Tilsvarende at anvende dette på et eller flere projekter:

  • Vælg på hovedmenulinjen Projekt -> Anvend copyright

Og så følger vi instruktionerne i Anvend copyright dialogboks for at tilføje copyright-overskriften til filerne:

  • Vi klikker på Næste knap, der fører os til Indstillinger for copyright
  • Vælg derefter en copyrightlicens fra Ophavsretstype vælg feltet
  • Og klik på Næste knap, der fører os til filvinduet
  • Endelig klikker vi på Afslut knappen for at anvende copyright-overskriften på de valgte kildefiler

Nu i modsætning til kodeskabelon, pluginet vil ikke automatisk tilføje en copyright-overskrift ved oprettelsen af ​​en ny fil.

Imidlertid har pluginet det flere fordele i forhold til kodeskabelonen:

  • Det er let at tilføje en copyrightlicensoverskrift til de eksisterende kildefiler
  • Vi kan inkludere brugerdefinerede variabler i licensteksten, som firmanavn
  • Pluginet understøtter mange forskellige copyrightlicensoverskrifter
  • Vi kan tilføje en copyright-overskrift til alle typer kildefiler og ikke begrænset til Java-kildefiler

4. Konklusion

I denne artikel har vi lært to forskellige måder at tilføje en copyrightlicensoverskrift til vores kildefiler.

Det Eclipse Copyright Generator plugin er den nemmeste og mest fleksible måde at tilføje copyright-overskrifter på.

Den eneste ulempe er, at den skal anvendes, efter filerne er oprettet, hvor kodeskabelonen tilføjer et copyright-overskrift til os, når hver fil oprettes.