2009-06-03 18 views
0

Ich habe ein kleines Problem mit der Versionsnummerierung in meinen Projekten.Javadoc Versionierung

zum Beispiel sagen, dass ich vier Klassen One Zwei Drei Vier

Das erste Mal, dass ich diese Software freigeben, wird es als Version 1.0.0

In meinem java doc beschriftbar Kommentar, für alle Klassen, ich habe es als @version 1.0.0

so, jetzt Test sendet ihn mit einem Fehler in der Klasse zurück Zwei

Ich aktualisiere Klasse Zwei und muss jetzt Version 1.0.1 freigeben

Aktualisiere ich jetzt das @version-Tag in jeder Klasse?

Oder komme ich irgendwann mit einer Reihe von Klassen mit unterschiedlichen Versionsnummern in den Javadoc-Kommentaren?

Antwort

0

Ich glaube, die richtige Antwort ändert nur die Dateien, die von dem Fehler betroffen sind.

Ich würde die Versionen oder Revisionen zu Ihrer Kontrollversion verlassen. In einer perfekten Welt würde ein Skript die Version synchron halten.

Natürlich ist diese Frage subjektiv. Wenn Sie das Version-Tag als Marketing-Tool verwenden möchten, dann möchten Sie wahrscheinlich alle Ihren Code die gleiche Version sagen.

1

Ich denke, dass Fehlerbehebungen dies überhaupt nicht beeinflussen, denn wenn Sie einen Fehler beheben, ändern Sie nur eine Revisionsnummer (die dritte) in der Versionsnummer. Und Sie müssen keine Revisionsnummer in Ihrem Javadoc eingeben - es ist nutzlos da javadoc verwendet wird, um API zu beschreiben und API ändert sich nicht mit der Behebung eines Fehlers.

Das bedeutet, dass Sie nur zum Beispiel @version 1.2 und nicht @version 1.2.6

Ihre javadoc setzen sollte nur ändert, wenn Sie Ihre API ändern - als Sie einen großen (1) ändern oder kleinere (2.) Versionsnummer und das sollte in Ihrem Javadoc projiziert werden.

Ich denke, Sie sollten nur Versionsnummern in Klassen ändern, die sich geändert haben, weil andere Klassen von früheren Versionen und damit Versionsnummer in "vererbt" werden Nicht geänderte Klassen sollten so bleiben wie sie sind. Aber ich bin mir nicht sicher ..