473,851 Members | 2,058 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

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

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
Nov 16 '05 #1
11 2660
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 :)
"ajikoe" wrote:
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

Nov 16 '05 #2
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
"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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

Nov 16 '05 #3
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 :)
"ajikoe" wrote:
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
"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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

Nov 16 '05 #4
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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
"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:

> 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

Nov 16 '05 #5
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 :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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
"Chua Wen Ching" wrote:

> 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 :)
>
>
> "ajikoe" wrote:
>
> > 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

Nov 16 '05 #6
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:

> 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
> "Chua Wen Ching" wrote:
>
> > 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 :)
> >
> >
> > "ajikoe" wrote:
> >
> > > 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

Nov 16 '05 #7
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...rs/XMLDocs.doc

Hope it helps you :)
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:

> 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 :)
>
>
> "ajikoe" wrote:
>
> > 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
> > "Chua Wen Ching" wrote:
> >
> > > 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 :)
> > >
> > >
> > > "ajikoe" wrote:
> > >
> > > > 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

Nov 16 '05 #8
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
"Chua Wen Ching" wrote:
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...rs/XMLDocs.doc

Hope it helps you :)
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:
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 :)
"ajikoe" wrote:

> 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
>
> "Chua Wen Ching" wrote:
>
> > 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 :)
> >
> >
> > "ajikoe" wrote:
> >
> > > 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
> > > "Chua Wen Ching" wrote:
> > >
> > > > 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 :)
> > > >
> > > >
> > > > "ajikoe" wrote:
> > > >
> > > > > 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

Nov 16 '05 #9
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

"ajikoe" wrote:
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
"Chua Wen Ching" wrote:
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...rs/XMLDocs.doc

Hope it helps you :)
--
Regards,
Chua Wen Ching :)
"ajikoe" wrote:
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

"Chua Wen Ching" wrote:

> 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 :)
>
>
> "ajikoe" wrote:
>
> > 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
> >
> > "Chua Wen Ching" wrote:
> >
> > > 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 :)
> > >
> > >
> > > "ajikoe" wrote:
> > >
> > > > 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
> > > > "Chua Wen Ching" wrote:
> > > >
> > > > > 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 :)
> > > > >
> > > > >
> > > > > "ajikoe" wrote:
> > > > >
> > > > > > 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

Nov 16 '05 #10

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

9
6519
by: Russ Perry Jr | last post by:
I'm using "ID" and "Value" in the generic sense here... Let's say one page I had a <html:select> with a collection like this: <html:options collection="items" property="key" labelProperty="value"/> In this case "key" is what I mean by "ID", and "value" is what I mean by "Value" -- the "Value" is shown to the user, but the "ID" is what I plan to keep, to be saved to a database (as a reference in a table to a common table as a part of...
3
3394
by: Marcus | last post by:
I'm running into a situation that has me adding a value of "Unknown" to a reference table. I am being pulled between two trains of thought, and was curious to get other's input on in. I give an example below. 1-) Adding "Unknown" to a reference table is bad. Doing so effectively changes the Nullability option of every FK that references the table to a NULLable FK relation. 2-) Simply adding a "Not Known/Undetermined" value to the...
12
4139
by: Jose Fernandez | last post by:
Hello. I'm building a web service and I get this error. NEWS.News.CoverNews(string)': not all code paths return a value This is the WebMethod public SqlDataReader CoverNews(string Sport) {
2
5670
by: IkBenHet | last post by:
Hello, I am uploading a file using this form in ASP.NET. I have also added a simpel textfield: <form runat="server" enctype="multipart/form-data"> <input type="file" id="oFile" Name="oFile" size="70" runat="Server"> <input type="text" SIZE="20" MAXLENGTH="20" id="Name" NAME="Name"> <input type="submit" id="Submit" runat="Server" value="Submit" OnServerClick="SubmitButton_Click"> </form>
12
13932
by: Emi Lu | last post by:
Hello all, I have a question about "date" & "timestamp" types in PostgreSQL. I want to setup the default value '0000-00-00' and "0000-00-00 00:00:00" for them. However, it seems that PostgreSQL does not support it. Could someone helps me please? The example table: T1 (col1 varchar(7) not null,
2
2582
by: Bilal | last post by:
Hello, I'm stuck on this problem for quite some time and hope somebody would be able to guide me. Basically, I need to populate a large number of "template" XML files which have all elements/attributes etc. defined but the values in these elements/attributes might be blank or place holders, as two examples below: Example - File type 1
21
2447
by: Steven T. Hatton | last post by:
I'm trying to improve my formal understanding of C++. One significant part of that effort involves clarifying my understanding of the vocabulary used to describe the language. This is from the C++ Standard: "" "...sequence of operators and operands that specifies a computation...". That means to me that an expression can be "executed". I am purposely
4
2047
by: stevewy | last post by:
If I am using srcElement (or "target" for non-IE models) to return various properties of an object I have clicked on, can I access for "label for" value in any way? I'm thinking, for example, of an input text box like this: <label for="fred">Username:</label> <input type="text" name="hello" id="hello1" size="10"> Now, once a function has:
5
2279
by: Diwa | last post by:
Does the "value" type (value as in key-value pair )of "std::map" require a default ctor even if it is not used ? If I comment out Line 1 in the code attached later, i.e remove the default ctor of "value" type of map, I get the following error: // -------------------------------------------- /usr/include/c++/3.2.3/bits/stl_map.h:225: no matching function for call to `FieldType::FieldType()'
0
9748
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
11020
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
7907
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
7073
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
5736
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
5934
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
4549
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
2
4143
muto222
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.
3
3180
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.