Re: [Springframework-developer] @since and @version tags

[Rod J. <rod...@in...>]

> I think it was discussed before, but I just wanted to re-iterate. I just
> want to be consistent with our javadoc style. I noticed there are some
> @since tags with the date. Personally I would prefer the release version
> as it's easier to see since what version the file (class) was
> introduced, i.e @since 1.0.2.

Good point. Maybe keep @since a date for things that predated 1.0?

>
> Also not all the files have @version tag with CVS $Id$ keyword
> substitution. So I would propose the standard javadoc template for every
> class, something like this:
>
> /**
>  * <Insert type description>
>  *
>  * @author <Developer Name>
>  * @since <Release version>
>  * @version $Id:$
> */
>
> ...plus any optional tags such as @see

+1. That looks like my code template (except I don't have @since).

I like id keywords...they're mainly in the code through my classes or
classes I've edited... (Damn, if it's standardized, I won't know if I've
worked on a particular file any more :-)

Rgds
Rod