473,405 Members | 2,344 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,405 software developers and data experts.

<example> tag doesn't work

Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

brgds Jesper.

/// <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>
Nov 13 '05 #1
3 2148
I know that I am replying to an older message, but wanted to bring up the
same issues with .Net 2003. I commented a lot of code last night. For some
of the methods in my class, I used the <summary> </summary> tags. Well, the
IDE does it automatically for you with ///.

Anyway, inside the <summary> area, I used <para></para> to start a new
paragraph. When I used the option to build comment web pages today from the
IDE, I checked them out and saw that the <para> tags were ignored.
Everything was run together on one line.

Anyone have any thoughts or suggestions on this?

Thanks.

"Jesper Odgaard" <je****@hotmail.com> wrote in message
news:99****************************@phx.gbl...
Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

Nov 15 '05 #2
Kerry,

This reply applies to C#, XML Documentation.

The Comment Web Report, in my opinion, has many flaws. I've seen a lot
of people using a OpenSource XML Documentor called "NDoc". This
program produces MSDN and other style docs.

As much as I've used this program, I have not been disappointed. It
does have some formatting "quarks" but don't all programs. With that
said it seems to follow/allow all of the XML Documentation Tags.

I think it's great your using the comments fully. I requier all my
programers to use the /doc directive to inforce proper commenting.

Hope this helps.

MSDN URL Ref Page:
"ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcwlkxmldocumentationtutorial.htm"

Glen Jones MCSD

"Kerry Sanders" <di****@yahoo.com> wrote in message news:<VP*******************@bignews4.bellsouth.net >...
I know that I am replying to an older message, but wanted to bring up the
same issues with .Net 2003. I commented a lot of code last night. For some
of the methods in my class, I used the <summary> </summary> tags. Well, the
IDE does it automatically for you with ///.

Anyway, inside the <summary> area, I used <para></para> to start a new
paragraph. When I used the option to build comment web pages today from the
IDE, I checked them out and saw that the <para> tags were ignored.
Everything was run together on one line.

Anyone have any thoughts or suggestions on this?

Thanks.

"Jesper Odgaard" <je****@hotmail.com> wrote in message
news:99****************************@phx.gbl...
Hi,

When documenting my code using comment web pages from the
visual studio .Net 2002 ide, it seems that it ignores the
<example> tag. Except for this tag everything works fine.
Can I customize the web pages to include examples?

Nov 15 '05 #3
Yep... thanks for the reply. In the past, our company has not had strict
rules for documenting and commenting code. Things are changing... finally.
I really love the XML documentation aspects of C#. I will see if I can find
NDoc or another utility to see if I can produce a good report from the XML
documentation.

"Glen Jones" <gl********@hotmail.com> wrote in message
news:ba**************************@posting.google.c om...
Kerry,

This reply applies to C#, XML Documentation.

The Comment Web Report, in my opinion, has many flaws. I've seen a lot
of people using a OpenSource XML Documentor called "NDoc". This
program produces MSDN and other style docs.

As much as I've used this program, I have not been disappointed. It
does have some formatting "quarks" but don't all programs. With that
said it seems to follow/allow all of the XML Documentation Tags.

I think it's great your using the comments fully. I requier all my
programers to use the /doc directive to inforce proper commenting.

Hope this helps.

MSDN URL Ref Page:
"ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcwlkxmldocumentationtutorial.htm"

Glen Jones MCSD

Nov 15 '05 #4

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

Similar topics

4
by: higabe | last post by:
Three questions 1) I have a string function that works perfectly but according to W3C.org web site is syntactically flawed because it contains the characters </ in sequence. So how am I...
3
by: Mark Bennett | last post by:
Hello, Embarrassing as it is, I'm stumped by a (I'd imagine) fairly elementary CSS problem. Consider the code below. We have a table with three columns, two of which are set to a width of...
7
by: Zhang Weiwu | last post by:
Hello. This is problem puzzled me a long time. I wish to organize some block elements and let them flow one after each other like text. Think about a album, I wish the album have 12 thumbnails,...
5
by: G?nter Omer | last post by:
Hi there! I'm just trying to compile a header file (unsing Borland C++ Builder 10)implementing a class, containing the declaration of the STL <list> but it refuses to work. The following...
11
by: Les Paul | last post by:
I'm trying to design an HTML page that can edit itself. In essence, it's just like a Wiki page, but my own very simple version. It's a page full of plain old HTML content, and then at the bottom,...
0
by: bcg | last post by:
I have a couple of places where I used the following text in my code, but the example and code text does not show up in the resultant comment web pages...why? The summary and parameter information...
1
by: John Mark Howell | last post by:
When using the example straight out of the MSDN and using the Visual Studio 2003's Build Comment Web Pages, you will not see the <example> section. It is in the generated XML file but I do not see...
8
by: Scott M. | last post by:
Where will code that is preceded with: /// <example> /// some comments /// </example> actually show up? I can see my <summaryand <remarkscode showing up in the code comment pages and in...
7
by: Jim in Arizona | last post by:
Using this: <asp:ListItem Value="0"</asp:ListItem> as long as I have a value listed and leave the area between the tags blank, when viewed the DropDownList will show a 0 as a choice. I want it...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
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...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...

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.