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

Reply via email to