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>
3  2168 
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?
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/vcwlkxmldocumen tationtutorial. htm"
Glen Jones MCSD
"Kerry Sanders" <di****@yahoo.c om> wrote in message news:<VP******* ************@bi gnews4.bellsout h.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?
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********@hot mail.com> wrote in message
news:ba******** *************** ***@posting.goo gle.com... 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/vcwlkxmldocumen tationtutorial. htm"
Glen Jones MCSD This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics | |
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 supposed to write this function?
String.replace(/</g,'<');
|
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 150px. The center cell has no specific
width and therefore grows/shrinks as the browser window is re-sized.
In the center cell is a <div>, set to display with the properties set
|
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, each one has a
comment line under the picture. And I wish when the screen size is big,
this thumbnails arrange 3 rows, 4 columns; if the browser window is
smaller, arranges 4 rows, 3 columns; if it's even smaller, 6 rows with 2
columns. If there...
|
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 errors occure:
"test.h" line 29 type name expected
"test.h" line 29 declaration missing
|
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, there's an "Edit"
link. So the page itself looks something like this:
<HTML><HEAD><TITLE>blah</TITLE></HEAD><BODY>
<!-- TEXT STARTS HERE -->
<H1>Hello World!</H1>
<P>More stuff here...</P>
| | |
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 show
fine.
/// <summary>
/// Summary information
/// </summary>
/// <example> The is an example.
/// <code>
|
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 it in the VS window. Does
anyone know how to get that to show up?
A second question is where is the XSL and CSS that VS is using to display
the XML?
Try the following example straight from the MSDN help:
/// <summary>
|
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 the Object Browser, but where will the example come into play?
|
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
to be blank.
I've tried doing this:
<asp:ListItem Value="0"> </asp:ListItem>
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look !
Part I. Meaning of...
|
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,...
| | |
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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
|
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();...
|
by: adsilva |
last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
|
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
|
by: muto222 |
last post by:
How can i add a mobile payment intergratation into php mysql website.
| | |
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...
| |
