I'd forgotten about the guidelines, but I agree with them all apart from @version $Id$.
$Id$ looks rather odd to me in a @version tag, so I tend to use @version $Revision$ updated on $Date$ which seems to me to be enough information for the Javadoc comments. It's much easier to pick out the version (and date) if that's all there is! I don't think that the file name and user information add anything useful to the Javadoc - the name of the class is already known, and there is a separate @author tag anyway .... But I agree that the extra information in the $Id$ is needed *somewhere* in the file. In fact, perhaps it would be better to add $Header$ at the start of each file, as this includes the full path name - which is quite important in JMeter, given the number of source directory trees. AFAICS, there's no harm in adding this as well, so I'll start putting $Header$ before the licence reference. Hope that's OK? S. ----- Original Message ----- From: "Jordi Salvat i Alabart" <[EMAIL PROTECTED]> To: "JMeter Developers List" <[EMAIL PROTECTED]> Sent: Monday, February 09, 2004 11:21 PM Subject: Re: ASF 2.0 licence Actually, the formatting guidelines we agreed to follow a while ago (http://jakarta.apache.org/turbine/common/code-standards.html) read: � 9. All .java files should have a @version tag like the one below. @version $Id: code-standards.xml,v 1.6 2003/03/12 21:34:39 quintonm Exp$ � Related, but not quite: I had the idea that it also required the author & version tags to come in the file-opening comment. But I can't find were I took this idea from, and I'm now thinking I've done it wrongly :-( I'll take care of moving those I find back to the class's JavaDoc comment. -- Salut, Jordi. [EMAIL PROTECTED] wrote: > Oops! that should have been // $Id$ ! > > ----- Original Message ----- > From: "BAZLEY, Sebastian" <[EMAIL PROTECTED]> > To: "'JMeter Developers List'" <[EMAIL PROTECTED]> > Sent: Monday, February 09, 2004 5:49 PM > Subject: RE: ASF 2.0 licence; Junit > > > >>-----Original Message----- >>From: peter lin [mailto:[EMAIL PROTECTED] >>Sent: 09 February 2004 17:35 >>To: JMeter Developers List >>Subject: Re: ASF 2.0 licence; Junit >> > > > BTW, I added: > > // $Id > > to the beginning of the URL*.java files so that the full file name is > present. > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
