Javadoc versioning

Question

J'ai un léger problème avec la numérotation des versions dans mes projets.

Dites par exemple que j'ai 4 classes Un Deux Trois Quatre

La première fois que je libère ce logiciel, il sera étiqueté comme la version 1.0.0

Dans mon doc java commenter, pour toutes les classes, je l'ai comme @version

1.0.0

Alors maintenant, test de l'envoie de retour avec un bug dans la classe deux

Je mets à jour la classe deux et je dois maintenant sortir la version 1.0.1

Est-ce que je mets maintenant à jour la balise @version dans chaque classe? Ou est-ce que je finis par avoir un tas de classes avec des numéros de version différents dans les commentaires de javadoc?

Answer 1

Je crois que la bonne réponse est juste de changer les fichiers affectés par le bogue. Je laisserais les versions ou les révisions à votre version de contrôle. Dans un monde parfait, un script garderait la version synchronisée.

Bien sûr, cette question est subjective. Si vous envisagez la balise de version comme un outil de marketing, alors oui, vous voudrez probablement garder tout votre code en disant la même version.

Answer 2

Je pense que les corrections de bogues n'affectent pas du tout cela, car lorsque vous corrigez un bogue, vous ne modifiez qu'un numéro de révision (le 3ème) dans le numéro de version. Et vous n'avez pas besoin de mettre un numéro de révision dans votre javadoc - c'est inutile car javadoc est utilisé pour décrire l'API et l'API ne change pas avec la correction d'un bug.

Cela signifie que vous devez mettre seulement par exemple @version 1.2 et non @version 1.2.6

Votre javadoc ne change que lorsque vous modifiez votre API - que vous devez changer un grand (1er) ou mineur (2e) numéro de version et qui devrait être projeté dans votre javadoc ..

Je pense que vous ne devriez changer que les numéros de version dans les classes qui ont changé, parce que d'autres classes sont "héritées" des versions précédentes et donc numéro de version dans Les classes non modifiées devraient rester telles quelles. Mais je ne suis pas sûr à ce sujet ..