Legge til Copyright License Header for Java Source Files i Eclipse

1. Oversikt

Å legge til en copyright-lisensoverskrift for kildefiler i Eclipse IDE er kjent for å være en vanskelig og feilutsatt oppgave.

I denne opplæringen lærer vi to måter å gjøre denne oppgaven enkel og feilfri. Den første bruker Eclipse IDEs kodemalfunksjon. Den andre bruker Copyright Generator Plugin.

2. Bruke kodemalen

La oss først se hvordan du legger til en lisensoverskrift på opphavsretten ved hjelp av kodemalen. La oss begynne med formørkelsen:

2.1. Formørkelse av formørkelsen

  • Gå til hovedmenylinjen Preferanser
  • Naviger deretter til Java -> Kodestil -> Kodemaler
  • Utvid vinduet fra høyre side av vinduet Kode seksjonen og velg Nye Java-filer
  • Så går vi til Rediger mal ved å klikke på Redigere knapp
  • I Rediger mal vindu, legger vi til copyright-lisensoverskriften i Mønster tekstområdet
  • Og klikk på OK for å oppdatere malen
  • Til slutt, la oss klikke på Søke om for å fullføre oppsettet

2.2. Bruk av copyright

Vi får nå en copyright-overskrift automatisk på hver nye Java-kildefil:

Derimot, denne metoden har noen ulemper:

  • Vi kan ikke bruke dette til å legge til en copyright-overskrift til eksisterende kildefiler
  • Vi kan ikke inkludere tilpassede variabler i lisenseteksten, som firmanavnet vårt
  • Det er ikke fleksibelt nok til at vi kan velge forskjellige opphavsrettslisensoverskrifter
  • Vi kan bare bruke dette på Java- og Javascript-kildefiler

Heldigvis er det et alternativ i form av plugin for copyright generator.

3. Bruke plugin-modulen Copyright Generator

La oss starte med å sette opp plugin-modulen Copyright Generator.

3.1. Installere programtillegget

  • Vi installerer pluginet ved å navigere til Hjelp -> Eclipse Marketplace
  • Så søker vi etter Eclipse Copyright Generator i Finne tekstboks
  • Til slutt, la oss klikke på Installere og følg instruksjonene

3.2. Tilpasse lisensoverskrifter for copyright

Alle vanlige copyright lisensoverskrifter er forhåndsinstallert med pluginet.

Men hva om vi vil legge til en tilpasset overskrift, eller redigere en? La oss se hvordan du gjør det i Opphavsrettsinnstillinger:

  • Vi navigerer først til Innstillinger -> Generelt -> Copyright
  • Deretter klikker vi på for å legge til en ny copyright-overskrift Legge til knapp
  • For å endre en eksisterende lisens, velger vi en lisens fra Lisenser og klikk deretter på Endre knapp

3.3. Bruk av copyright

Etter at du har installert pluginet, er det ganske enkelt å bruke en copyright-lisensoverskrift på en eller flere kildefiler.

La oss se hvordan du bruker den på de valgte kildefilene:

  • Fra Prosjektutforsker panelet, velger vi kildefilene
  • Deretter, Høyreklikk på de valgte kildefilene
  • Fra hurtigmenyen velger vi Bruk copyright alternativ

På samme måte kan du bruke dette på ett eller flere prosjekter:

  • Velg fra hovedmenylinjen Prosjekt -> Bruk copyright

Og så følger vi instruksjonene i Bruk copyright dialogboksen for å legge til copyright-overskriften til filene:

  • Vi klikker på Neste -knappen, som tar oss til Innstillinger for copyright
  • Velg deretter en lisens fra copyright Copyright type velg rute
  • Og klikk på Neste -knappen, som tar oss til filvinduet
  • Til slutt klikker vi på Bli ferdig knappen for å bruke copyright-overskriften til de valgte kildefilene

Nå i motsetning til kodemalen, pluginet vil ikke legge til en copyright-overskrift automatisk når du oppretter en ny fil.

Imidlertid har plugin flere fordeler i forhold til kodemalen:

  • Det er enkelt å legge til en copyright-lisensoverskrift for de eksisterende kildefilene
  • Vi kan inkludere tilpassede variabler i lisenseteksten, som firmanavn
  • Programtillegget støtter mange forskjellige lisensoverskrifter
  • Vi kan legge til en copyright-overskrift til alle typer kildefiler og ikke begrenset til Java-kildefiler

4. Konklusjon

I denne artikkelen har vi lært to forskjellige måter å legge til en lisensoverskrift på copyright til kildefilene våre.

De Eclipse Copyright Generator plugin er den enkleste og mest fleksible måten å legge til copyright-overskrifter.

Den eneste ulempen er at den må brukes etter at filene er opprettet, hvor kodemalen vil legge til en copyright-overskrift for oss når hver fil blir opprettet.