Copyright-Header mit IntelliJ verwalten

Ihr kennt es sicher, in jeder Quellcode-Datei soll oder muss ein standardisierter Kommentarheader rein. Mit Copyright und / oder Lizenzinformationen, vielleicht Autor, und und und.

Nun können wir uns in der Regel in unseren IDEs damit helfen, dass wir Templates für unsere Typen anlegen (z.B. Klassen, Interfaces, …) aber was ist mit den ganzen anderen Dateien in unserem Projekt?

Was ist mit den HTML-Dateien, den Java-Script-Dateien oder CSS? Was ist mit anderen Sprachen, etwa mit PHP? Müssen wir die Templates alle einzeln Pflegen? Und  dann in jedem Jahr überall die Jahreszahl hinter dem Copyright aktualisieren? Och nööö…

IntelliJ bietet uns hierfür eine sehr elegante Lösung. Die Texte für die Copyrights lassen sich nämlich auch außerhalb der Templates pflegen und diese gelten dann für alle Arten von Dateien.

Dazu muss man nur über die Settings den Punkt Editor -> Copyright aufrufen. Hier können nun unterschiedliche Profile angelegt werden. Das ist sinnvoll, wenn man z.B. verschiedene Header einfügen muss (bei mir etwa für meinen Arbeitgeber, für private Solo-Projekte oder für unsere InvidIT-Projekte).

Hier also einfach ein Profil anlegen, den Text eingeben und fertig. Die oben angesprochene Jahreszahl lässt sich dabei ganz einfach durch eine Variable ersetzen.

Zur Verdeutlichung noch einmal, wie das ganze aussieht:

IntelliJ-Copyright-Einstellungen

  1. Menüpunkt aufrufen
  2. Profil anlegen -> Namen vergeben
  3. Text pflegen. Zeilenumbrüche funktionieren hier

 

Erstellt man nun eine neue Datei, wird der Copyright-Kommentar passend eingefügt – abhängig von Typ und Sprache.

Das Keyword, welches man angeben kann, dient dazu, dass man im gesamten Projekt alle Kommentare, in denen dieses Keyword vorkommt, durch den oben angegebenen Kommentar ersetzen lassen kann. Das kann auch durchaus praktisch sein.

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.