Book a Demo

Author Topic: CTF - XML_COMMENT Keywords?  (Read 2474 times)

buosc

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
    • View Profile
CTF - XML_COMMENT Keywords?
« on: March 25, 2004, 01:38:06 pm »
According to the CTF documentation XML_COMMENT adds an XML comment for the current item's note field.  Thus, using XML_COMMENT on this note field:

This is a note field describing my stuff.

would cause the following to be output:

/// <summary>
/// This is a note field describing my stuff.
/// </summary>

I discovered that if a note field has "@remarks" in it also outputs a remarks section.  Thus, using XML_COMMENT on this note field:

This is a note field describing my stuff.

@remarks These are further comments about my stuff.

would cause the following to be output:

/// <summary>
/// This is a note field describing my stuff.
/// </summary>
/// <remarks>These are further comments about
/// my stuff.</remarks>

I have 2 questions about this.  
- What keywords are supported in this fashion (or is it just anything with a preceding @)?
- Is there any way to control the output format of the XML_COMMENT (or conversely to access the seperate parts of the note field as delineated by the @ tagged values)?

Thanks in advance,
Jon

buosc

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
    • View Profile
Re: CTF - XML_COMMENT Keywords?
« Reply #1 on: March 25, 2004, 03:48:08 pm »
More questions regarding this topic as I delve further...

For operations somehow calls to XML_COMMENT also create param xml comment nodes for each defined parameter as well.  In addition, @param can be specified in the note field for parameters.  How can these be manipulated such that the output can be controlled?  We use the xml comments to create documentation and need somewhat consistent output.