XML Comment structure

[james autry]

When using the IDE, and the XML based auto commenting feature, how does one
format an input parameter that is a structure. ie. describing each element
of the structure between one <param> block. Is there a way to define a
newline within this block so that the format is readable when the tooltip
appears.

Thanks

[Peter Rilling]

Well, you can put whatever you want in the comment block and that will be
included in the assemblyname.xml; however, existing tools will not be able
to process it. A <param> is just a description of that parameter. If you
are passing a structure in, the user can see that as the parameter type in
the signature, then they could cross-reference the structure documentation
if needed. Most likely they would have set the information in the structure
prior to calling the method, so when they set the structure properties, the
XML documentation will kick in for each property they set but there is no
need to include this information on the method call that uses the parameter.

Did I answer you question?

"james autry" <j.*******@earthlink.net> wrote in message
news:bu*****************@newsread2.news.pas.earthl ink.net...

When using the IDE, and the XML based auto commenting feature, how does one format an input parameter that is a structure. ie. describing each element of the structure between one <param> block. Is there a way to define a
newline within this block so that the format is readable when the tooltip
appears.

Thanks