|
From: jbetancourt <jbe...@co...> - 2004-07-27 23:44:10
|
BTW, CVS keyword expansions can make some things like branching and merging very difficult. For example, the $Id$ always show as conflicts and some command line options to get around them play havoc with binary files. Disregard if branching is not applicable in this project, or if I'm incorrect regarding CVS branching difficulty. -- J. Betancourt ----- Original Message ----- From: "Dmitriy Kopylenko" <dko...@ru...> To: <spr...@li...> Sent: Tuesday, July 27, 2004 2:20 PM Subject: [Springframework-developer] @since and @version tags > 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. > > 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 > > What does everyone think? > > Regards, > Dmitriy. > > > ------------------------------------------------------- > This SF.Net email is sponsored by BEA Weblogic Workshop > FREE Java Enterprise J2EE developer tools! > Get your free copy of BEA WebLogic Workshop 8.1 today. > http://ads.osdn.com/?ad_id=4721&alloc_id=10040&op=click > _______________________________________________ > Springframework-developer mailing list > Spr...@li... > https://lists.sourceforge.net/lists/listinfo/springframework-developer > |