Build comment web pages for "value" and "example"

[Guest]

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.

 

[Guest]

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo

 

[Guest]

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.

 

[Guest]

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo

 

[Guest]

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hello,
I tried to write down this example from help file:
public class MyClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
public static void Main ()
{
}
}

And I tried to use object browser to find out if I can see the example but still I can't

Pujo

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hi Ajikoe,

Did you generate the xml file out when you build you application?

A very good guide. Please download this.

http://www.gotdotnet.com/team/csharp/learn/whitepapers/XMLDocs.doc

Hope it helps you
--
Regards,
Chua Wen Ching

Hello,
I tried to write down this example from help file:
public class MyClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
public static void Main ()
{
}
}

And I tried to use object browser to find out if I can see the example but still I can't

Pujo

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

:

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hi Chua Wen Ching,

I generated xml file when I build my application.
But Again, It given't any effect when I goes into example and value tag?

You know it is funny when I tried to update my visual c# from the help menu, it always said that :
"Visual Studio. NET 2003 setup encaunered errors while attemting to download required files. Check your web browser configuration settings and your connection hardware, and try again"
Although I can update my windows security update. I use my own laptop and connection in Graz Technical University. The internet connection is ok, and I can download anything except the visual studio.net. Is this also because standard edition?

Sincerely Yours,
Pujo

Hi Ajikoe,

Did you generate the xml file out when you build you application?

A very good guide. Please download this.

http://www.gotdotnet.com/team/csharp/learn/whitepapers/XMLDocs.doc

Hope it helps you
--
Regards,
Chua Wen Ching

Hello,
I tried to write down this example from help file:
public class MyClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
public static void Main ()
{
}
}

And I tried to use object browser to find out if I can see the example but still I can't

Pujo

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching


:

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

:

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hi Chua,

I guess I found the problem, it's because I don't give the same name to my xml files. thanks for the xmldocument that file is very helpfull.
Yes, for the example only can be seen through object browser.

By the way I can't still update my microsoft visual c#.
I want to try ndoc, is it ok for version 1.2 or I should install version 1.3?

Sincerely Yours,
Pujo Aji

Hi Chua Wen Ching,

I generated xml file when I build my application.
But Again, It given't any effect when I goes into example and value tag?

You know it is funny when I tried to update my visual c# from the help menu, it always said that :
"Visual Studio. NET 2003 setup encaunered errors while attemting to download required files. Check your web browser configuration settings and your connection hardware, and try again"
Although I can update my windows security update. I use my own laptop and connection in Graz Technical University. The internet connection is ok, and I can download anything except the visual studio.net. Is this also because standard edition?

Sincerely Yours,
Pujo

Hi Ajikoe,

Did you generate the xml file out when you build you application?

A very good guide. Please download this.

http://www.gotdotnet.com/team/csharp/learn/whitepapers/XMLDocs.doc

Hope it helps you
--
Regards,
Chua Wen Ching

Hello,
I tried to write down this example from help file:
public class MyClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
public static void Main ()
{
}
}

And I tried to use object browser to find out if I can see the example but still I can't

Pujo

:

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching


:

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

:

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[Guest]

Hello Chua,

I'm not able to show the value tag (in object browser ,in popup menu or in html format), for the example tag it is working (only in object browser)

Sincerely Yours,
Pujo Aji

Hi Chua,

I guess I found the problem, it's because I don't give the same name to my xml files. thanks for the xmldocument that file is very helpfull.
Yes, for the example only can be seen through object browser.

By the way I can't still update my microsoft visual c#.
I want to try ndoc, is it ok for version 1.2 or I should install version 1.3?

Sincerely Yours,
Pujo Aji

Hi Chua Wen Ching,

I generated xml file when I build my application.
But Again, It given't any effect when I goes into example and value tag?

You know it is funny when I tried to update my visual c# from the help menu, it always said that :
"Visual Studio. NET 2003 setup encaunered errors while attemting to download required files. Check your web browser configuration settings and your connection hardware, and try again"
Although I can update my windows security update. I use my own laptop and connection in Graz Technical University. The internet connection is ok, and I can download anything except the visual studio.net. Is this also because standard edition?

Sincerely Yours,
Pujo

Hi Ajikoe,

Did you generate the xml file out when you build you application?

A very good guide. Please download this.

http://www.gotdotnet.com/team/csharp/learn/whitepapers/XMLDocs.doc

Hope it helps you
--
Regards,
Chua Wen Ching


:

Hello,
I tried to write down this example from help file:
public class MyClass
{
/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
/// text for Main
public static void Main ()
{
}
}

And I tried to use object browser to find out if I can see the example but still I can't

Pujo

:

Hi ajikoe,

Sorry for the late reply. I can't remember where i post this.

Okay, the value and example xml tags are used in the object browser or intellisense purpose. You will have to generate a xml file, in the project properties.

Make sure it is the same file name with the Project example:

Project1.exe
Project1.xml

Those xml tags can be seens in a object browser, if you notice it. But you cannot see value and example in the html generated page. You need to use ndoc if possible.

Good Luck! Correct me if i am wrong.
--
Regards,
Chua Wen Ching


:

Hello Chua Wen Ching,

I tried "param" tag is working for documenting the method/function:
if the method is function which return value.

But if it is void so there is no description for the void type.

for "example" it is not working, can you give me an example for the "example" tag, and what it looks like?

thanks
pujo

:

Hi ajikoe,

From my understanding, only 2 kind of xml elements that can be used into vs.net xml report generation. Try this:

Assuming:

/// <summary>
/// The main entry point for the application.
/// </summary>
/// <remarks>Just a sample app!</remarks>
[STAThread]
static void Main(string[] args)
{
}

1) Inside VS.NET, go to Tools, then select Build Comments Web Page.

2) The Build Comments Web Pages will appear. Select entire solution for any particular solution you want.

3) Use the default settings, and press Ok.

4) You will see a generated comment file.

5) Navigate the tree, solution -> project -> main (inside you can see the summary and remark).

Anyway I know until now in vs.net 2003 <remarks> and <summary> are the only one that works.

Even though you can <example> xml element in there.

Please correct me if i am wrong! Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

Have you tried using value and example?
How it looks in HTML format?

I don't know How it looks like cause this is the first time I use XML documentation, I just want to know why those tag(value and example) is not working.

Sincerely Yours,
pujo
:

Hi ajikoe,

The most common xml doc syntax if you vs.net doc generation is

<summary>
<remarks>

But if you use ndoc, you can place your own xml tags. Check this out. Cool tool.

http://ndoc.sourceforge.net/

Hope it helps. Cheers.
--
Regards,
Chua Wen Ching


:

Hello,

I used Visual C# Standard Edition.
I want to comment my program using xml commentary method,
I don't know why if I use value and example tag, it is not working / showed in the html result.
for example I have Property

///<value>this is in description</value>
///<example>this is in Example</example>
public int A{
get{
return 27;
}
}

Note: it works for "remark" and "summary" tag
Can anyone help me?
Thanks
Pujo

 

[KD]

Ajikoe,

Go for the 1.3 beta release or, even better, download the nightly source and
build the latest code yourself - there have been a huge number of bug fixes,
enhancements and performance improvements since 1.2 was released...

If you don't want to build the code yourself, the beta 1.3a is ok, but there
were a couple of annoying bugs that have since been fixed. There should be
another official beta release coming out within the next couple of weeks.

regards,
Kevin

Hi Chua,

I guess I found the problem, it's because I don't give the same name to my

xml files. thanks for the xmldocument that file is very helpfull.