@version in Kommentaren aktualisieren

[Schuriko]

In meinen Java-Dateien habe ich am Anfang einen Kommentar mit Namen, @Author und @version stehen. Also wie folgt:

/**
* MeinProgramm
*
* @author Schuriko
* @version 1.2.1
*/

Da ich mehrere Java-Dateien habe will ich bei einer aktualisierten Version nicht alle Dateien anfassen, gibt es ein Tool, welches die Version ersetzt auf die aktuelle Version setzt. Oder bleibt einem nur der Weg über Datei-Suchen/Ersetzen?

 

[MoxxiManagarm]

Ich denke wenn das überhaupt irgendwie geht, dann ist das IDE-spezifisch. Aber ich bezweifle es, wirst wohl mit search+replace machen müssen.

Ich stelle allerdings die Sinnhaftigkeit in Frage. @version spiegelt meiner Erfahrung nach die letzte Änderung deiner Datei wieder, nicht die Version deines Projektes. Da es die letzte Änderung ist, musst du die Datei ohnehin anfassen. Also solltest du das im Moment der Änderung updaten.

 

[White_Fox]

@version spiegelt meiner Erfahrung nach die letzte Änderung deiner Datei wieder

Genau, das ist auch am Sinnvollsten. Stell dir mal vor du beschließt, ein wesentliches Package deines Programms in eine eigenständige Bibliothek auszulagern. Ab diesem Punkt würde das @version-Tag irreführende Informationen herumschleppen.

Eine einzelne Datei sollte nicht wissen, welche Version das Gesamtprojekt hat. Für so etwas ist die Projektverwaltung zuständig. Nicht umsonst gibt es Werkzeuge wie Git oder SVN.

 

[mihe7]

"This tag is intended to hold the current version number of the software that this code is part of"

The Java Software convention for the argument to the @version tag is the SCCS string "%I%, %G%", which converts to something like " 1.39, 02/28/97" (mm/dd/yy) when the file is checked out of SCCS.

 

[MoxxiManagarm]

"This tag is intended to hold the current version number of the software that this code is part of"

Ain't nobody got time for that

 

[White_Fox]

Hehe, dieser Moment wenn man merkt, jeder macht es anders als der Hersteller es ursprünglich mal im Sinn hatte...

 

[kneitzel]

Diese Versionierung halte ich auch für relativ problematisch. Wie sieht es mit zwischenversionen aus?

Du hast die Version 1.2.1 und auf dem Weg zur 1.2.2 hast du mehrere Versionen der Datei? Sind das dann alles 1.2.1-Snapshot Versionen?

Bei der Versionsversaltung macht es Sinn, eine Version zu kennzeichnen. Dann ist aber klar: diese eine Version ist 1.2.1.

Aber wenn du 3 unterschiedliche Versionen alle mit 1.2.1 hast, dann finde ich das etwas problematisch ...

Und wenn, dann würde ich das ggf. über ein Script lösen. Dann hätte ich die Version einmal und die würde an allen Stellen gezielt gesetzt. Aber das mutet doch etwas seltsam an. So haben wir früher mal gearbeitet. Da war dann eine Version und auch die ganze History im Kopf der Datei ... aber das hat sich ja jetzt verschoben und findet sich in den Commits selbst.

 

[mihe7]

Persönlich verwende ich das version-Tag überhaupt nicht und halte das vorgeschlagene Vorgehen auch für unsinnig bzw. nur im Zusammenhang mit dem VCS sinnvoll. Manuell würde ich dort höchstens die Version der Spezifikation angeben - nur, wer macht das schon?

 

[MoxxiManagarm]

Es stimmt, vor den gängigen Version Control Konzepten habe ich auch oft History etc im Kommentar Header gesehen. Aber das ist mindestens 1 Jahrzehnt her heute sehe ich das Version Tag nicht mehr, wenn überhaupt steht meistens oben nur der Autor drüber

 

[kneitzel]

Als Anmerkung evtl. bezüglich Autor: das sehe ich auch etwas kritisch. Wer Änderungen macht, sieht man in der Versionsverwaltung.

Die Problematiken im Detail:
- wenn mehrere Personen Änderungen vornehmen: wer steht dann da als Autor? Wird das dann eine Liste?

Was soll das aussagen?
- Geht es um Urheberrecht? Das ist juristisch ggf. kritisch. Das wäre dann auch eher sowas wie Copyright oder so ... Und das läuft dann doch auch eher Richtung Lizenz ....
- soll das eine Art Besitz kennzeichnen? So nach dem Motto: das ist mir - lass da die Finger weg! Das entspricht nicht dem Team Gedanken. Oder der Sicht eines Unternehmens ....

Daher lasse ich sowas auch in der Regel weg. Aber da kann sich jeder überlegen, wie er das handhaben möchte ...

Es stimmt, vor den gängigen Version Control Konzepten habe ich auch oft History etc im Kommentar Header gesehen. Aber das ist mindestens 1 Jahrzehnt her heute sehe ich das Version Tag nicht mehr, wenn überhaupt steht meistens oben nur der Autor drüber

Ja, wenn ich das einordnen müsste, dann war das vor svn ... svn war 2000 ... also deutlich über ein Jahrzehnt....

 

[mihe7]

Als Anmerkung evtl. bezüglich Autor: das sehe ich auch etwas kritisch. Wer Änderungen macht, sieht man in der Versionsverwaltung.

Ja, der Autor ist auch so ein Käse.