Merrill,
/* ... */ and // ... style comments cannot be pinned to a language element any more than a <!-- ... --> style comment can. I think it is generally accepted that comments precede the thing that they describe.
Having said that, I suppose the 'comment' attribute you're suggesting isn't a world apart from the 'description' attribute of a 'project' element. Maybe it's not such a bad idea after all.
Cheers,
Richard.
-----Original Message-----
From: Merrill Cornish [mailto:[EMAIL PROTECTED]]
Sent: 27 August 2004 15:44
To: [EMAIL PROTECTED]; [EMAIL PROTECTED]; [EMAIL PROTECTED];
[EMAIL PROTECTED]
Subject: RE: [Nant-users] Properties Descriptions
Jim,
>>> How would this differ from using XML comments in the build files?
Clumsiness, or lack thereof.
<!-- location of the MSI installation log -->
<property name="msiexec.log" value="${sys.os.folder.temp}msiexec.log" />
or
<property name="msiexec.log" value="${sys.os.folder.temp}msiexec.log" />
<!-- location of the MSI installation log -->
versus
<property name="msiexec.log" value="${sys.os.folder.temp}msiexec.log"
comment="location of the MSI installation log" />
XML comments are verbose and stand on a level with the elements they are supposed to be commenting on. Therefore, it's not always clear who they apply to.
Most programming languages not only have provision for stand-alone comment lines (such as <!--...--> provides for XML) but also embeded (e.g., /*...*/) or end of line (e.g., //...) comments that are clearly associated with a single statement or even a single _expression_.
A comment attribute would make it clear to the reader (or automated documentation extraction program) who the comment text is associated with while a stand-along XML comment is ambiguous.
Merrill
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
Nant-users mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/nant-users
DISCLAIMER: The information contained in this e-mail is confidential and may be privileged. It is intended for the addressee only. If you are not the intended recipient, please delete this e-mail immediately. The contents of this email must not be disclosed or copied without the sender's consent. We cannot accept any responsibility for viruses, so please scan all attachments. The statements and opinions expressed in this message are those of the author and do not necessarily reflect those of the company. The company does not take any responsibility for the views of the author.
