Neues Update-Copyright-Tool vereinfacht Verwaltung von Urheberrechtsvermerken

Copyright-Vermerke in PhpStorm verwalten
Kommentare

Um Urheberrechtsverstöße zu vermeiden, bringen die meisten Code-Repositories entsprechende Urhebervermerke mit sich – allerdings oft an verschiedenen Stellen. Ebenso gibt es zuweilen Fälle, bei denen jede Datei mit einem Urhebervermerk gekennzeichnet ist, der natürlich stets aktuell sein sollte. Um das Aktualisieren solcher Vermerke zu vereinfachen, bietet PhpStorm nun ein neues „Update Copyright“-Tool, mit dem sie sich in einzelnen oder mehreren Dateien verwalten lassen.

In einem Blogpost im JetBrains-Entwicklerblog hat Gary Hochkin das neue Tool vorgestellt und zeigt, wie es sich nutzen lässt.

Urhebervermerke in PhpStorm

Damit sich die Urhebervermerke in PhpStorm modifizieren lassen, muss zunächst der Umgang der IDE mit Copyright-Benachrichtigungen definiert werden. Dabei spielen zum einen das Copyright-Profil, zum anderen der Projektrahmen (Scope) eine Rolle.

Mit dem Copyright-Profil wird definiert, wie der Urhebervermerk in den Dateien aussehen soll. Es enthält sowohl ein Template, in dem das Aussehen des Vermerks festgelegt wird, als auch jegliche Regeln zum Aktualisieren – also wann und wie das Update vorgenommenen werden soll. Die entsprechenden Optionen dafür finden sich in den Einstellungen im Editor-Bereich unter dem Punkt „Copyright“.

Der Scope beschreibt zudem, welche Projektbereiche mit dem Urhebervermerken beeinflusst werden sollen. So können Copyright-Vermerke sowohl in einzelne Dateien, Directories oder ganzen Projekten aktualisiert und verwaltet werden. Sobald ein Copyright-Profil und der Rahmen definiert sind, kann selbiger auf ein Profil angewandt werden.

Go for PHP Developers

mit Terrence Ryan (google)

Everything you need to know about PHP 7.2

mit Sebastian Bergmann (thePHP.cc)

Copyright-Vermerke aktualisieren

Wie sich Urhebervermerke in allen Dateien aktualisieren lassen, erklärt Hochkin am Beispiel der Zend\EventManager-Komponente. Wird ein neues Profil angelegt, enthält dieses einen Beispiel-Copyright-Text, indem die Velocity-Variable $today.year automatisch das aktuelle Jahr einfügt (siehe Screenshot).

Einstellung des Copyrightvermerk-Texts

Einstellung des Copyrightvermerk-Texts, Quelle: http://blog.jetbrains.com/phpstorm/2016/01/managing-copyright-notices-in-phpstorm/

Die Formatierung lässt sich ebenfalls anpassen; als Default erscheint der Urhebervermerk als PHP-Kommentarblock im oberen Bereich jeder Datei. Anschließend kann das Profil mit dem Scope verbunden und der Befehl Update Copyright… im Code-Menü ausgeführt werden, um die gewünschte Aktualisierung vorzunehmen.

Aufmacherbild: Crumpled copyright symbols. Copyright concept. von Shutterstock / Urheberrecht: StepanPopov

Unsere Redaktion empfiehlt:

Relevante Beiträge

Meinungen zu diesem Beitrag

X
- Gib Deinen Standort ein -
- or -