XML Commenting problem.

[Naveen Mukkelli]

Hi All,

I'm trying to create XML commenting for my code using XML commenting
feature
for the first time. I'm using VS.NET 2003 and C#.
I'v tried the following way.

Step 1: set the file name for xml file in
"Project Properties | Configuration Properties | Build |
XML Documentation File"
Step 2: tools | Build Comment Web pagers..

my code for commenting..
namespace Test
{
/// <summary>
/// Summary description for TEST
/// </summary>
class Test
{
///<remarks>
///TESTING COMMENTS
///</remarks>
///

[STAThread]
static void Main(string[] args)
{

}
}
}

but only a blank XML file is being created..

Kindly let me know where I went worng and also suggest me the best way to
incorporate "help" for the C# projects.

[Bruce Wood]

I don't know why only a blank XML file is being created, but I
generally keep the <remarks> section together with the <summary>, like
this:

/// <summary>
/// ...
/// </summary>
/// <remarks>
/// ...
/// </remarks>
public class ...

Nonetheless, the XML shouldn't be empty....

[Naveen Mukkelli]

Hi,

I, kind of, figured out why the xml is empty.

I'm using Windows XP SP2 and my security settings were set to
"High". So, I'm assuming that this is blocking XML content.
This assumption might be wrong, as I have no clue how XML works.

Once, I changed my security settings to "Medium", internet explorer is
displaying the content.

I'm also learning to use NDoc..
I'm facing a strange problem, at least for me.
I could not find the XML file. I'm able to generate XML comment web page
though.

How can we generate XML file from C# code comments so that we can use
the XML file in NDoc..

Kindly let me know.

Cheers,

Naveen.

"Bruce Wood" wrote:

I don't know why only a blank XML file is being created, but I
generally keep the <remarks> section together with the <summary>, like
this:

/// <summary>
/// ...
/// </summary>
/// <remarks>
/// ...
/// </remarks>
public class ...

Nonetheless, the XML shouldn't be empty....

[Greg Merideth]

I tried that and even at high setting I can view the documentation
created from my project.

Are you viewing the .xml file across a network share by any chance?

Naveen Mukkelli wrote:

Hi,

I, kind of, figured out why the xml is empty.

I'm using Windows XP SP2 and my security settings were set to
"High". So, I'm assuming that this is blocking XML content.
This assumption might be wrong, as I have no clue how XML works.

Once, I changed my security settings to "Medium", internet explorer is
displaying the content.

I'm also learning to use NDoc..
I'm facing a strange problem, at least for me.
I could not find the XML file. I'm able to generate XML comment web page
though.

How can we generate XML file from C# code comments so that we can use
the XML file in NDoc..

Kindly let me know.

Cheers,

Naveen.

"Bruce Wood" wrote:

I don't know why only a blank XML file is being created, but I
generally keep the <remarks> section together with the <summary>, like
this:

/// <summary>
/// ...
/// </summary>
/// <remarks>
/// ...
/// </remarks>
public class ...

Nonetheless, the XML shouldn't be empty....