2010-08-05 9 views
5

Existe-t-il un outil pour ajouter automatiquement la balise @since à tous les éléments lorsque je souhaite avoir une version commerciale?Balise @since javadoc automatique pour les versions

Alors disons que j'ai un tas de méthodes et mon système de base fonctionne maintenant, donc je décide de le libérer en tant que version 0.1.0

Ce que je veux est maintenant un outil qui recherche tous les @since manquantes tag et l'ajoute en conséquence. J'utilise Eclipse et j'ai trouvé JAutodoc, mais pour autant que je puisse le voir il ne permet que de rechercher les balises manquantes et je devrais les ajouter manuellement. Une solution de contournement qui pourrait être intéressante pour quelqu'un: Depuis le début, utilisez un modèle Eclipse avec le droit depuis tag et après chaque version, modifiez le modèle.

+0

Bonne question. – whiskeysierra

Répondre

3

Cela ressemble à quelque chose que votre outil de construction devrait vous fournir. Si vous utilisez maven, jetez un oeil à javadoc: fix. On dirait qu'il fait exactement ce que vous voulez:

http://maven.apache.org/plugins/maven-javadoc-plugin/fix-mojo.html

+0

J'ai essayé de regarder dans maven il y a un moment. Au début, il semblait très prometteur et il le fait toujours. Mais jusqu'à présent, je n'ai jamais réussi à le faire fonctionner. Quoi qu'il en soit, à partir du mois prochain, j'espère avoir plus de temps et je reviendrai sur le sujet. Donc merci pour l'instant! – Mene

0

Puis-je ajouter une leçon que j'ai appris il y a environ 27 ans: ne pas essayer de faire vos numéros de contrôle de version aligner avec vos numéros de version du produit. De cette façon, la folie ment.

+0

Eh bien, le problème est le suivant: si votre API est publique et que d'autres l'utilisent et que vous avez des versions différentes et que tout le monde n'a pas les dernières nouveautés, c'est une bonne chose de savoir si elles peuvent utiliser une méthode spécifique. Ou avez-vous une meilleure solition? Je suis toujours ouvert, D – Mene