473,320 Members | 1,940 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,320 software developers and data experts.

C# Xml Documentation and Object Browser

I am looking for an example using a summary element to have both a see and
seealso tag within the summary to get them to show up as links in the Object
Browser.

The following is what I am using and it doesn't work, can someone please help?
<pre>
namespace MyNamespace
{
/// <summary>
/// Summary description for DocExample.
/// </summary>
public class DocExample
{
/// <summary>
/// here is my description of MyMethod,
/// Trying the see tag to DoSomething: <see cref="DoSomething"/> - doesn't
work.
/// Trying the see tag to DoSomething with wrapping text: <see
cref="DoSomething">Some text</see> - doesn't work.
/// Trying the see tag to DoSomething using class: <see
cref="DocExample.DoSomething">Some text</see> - doesn't work.
/// Trying the see tag to DoSomething using namespace,class: <see
cref="MyNamespace.DocExample.DoSomething">Some text</see> - doesn't work.
/// </summary>
public void MyMethod()
{
}

/// <summary>
/// the method does something as well.
/// </summary>
private void DoSomething()
{
}
}
}
</pre>

None of the above examples work to display as expected in the Object browser.

Thanks in advance.
--
Robert
Jul 22 '05 #1
2 2739
Object Browser in VS.NET 2003 does not display links.

If you want to use the <see> link it is only for HTML or compiled HTML help documentation.

Tools --> Build Comment Web Pages...

or, you can use a third party utility such as NDOC.

Just a note: In my experience intellisense suggests to write <seealso> tags within the <summary> tag, although that doesn't seem to
work properly when the help files are compiled. Instead, place all <seealso> tags outside of the summary as a standalone tag.
<see>, however, works fine within the <summary> tag (and any other tag for that matter).

GL

--
Dave Sexton
dave@www..jwaonline..com
-----------------------------------------------------------------------
"rgrandidier" <rg*********@discussions.microsoft.com> wrote in message news:9C**********************************@microsof t.com...
I am looking for an example using a summary element to have both a see and
seealso tag within the summary to get them to show up as links in the Object
Browser.

The following is what I am using and it doesn't work, can someone please help?
<pre>
namespace MyNamespace
{
/// <summary>
/// Summary description for DocExample.
/// </summary>
public class DocExample
{
/// <summary>
/// here is my description of MyMethod,
/// Trying the see tag to DoSomething: <see cref="DoSomething"/> - doesn't
work.
/// Trying the see tag to DoSomething with wrapping text: <see
cref="DoSomething">Some text</see> - doesn't work.
/// Trying the see tag to DoSomething using class: <see
cref="DocExample.DoSomething">Some text</see> - doesn't work.
/// Trying the see tag to DoSomething using namespace,class: <see
cref="MyNamespace.DocExample.DoSomething">Some text</see> - doesn't work.
/// </summary>
public void MyMethod()
{
}

/// <summary>
/// the method does something as well.
/// </summary>
private void DoSomething()
{
}
}
}
</pre>

None of the above examples work to display as expected in the Object browser.

Thanks in advance.
--
Robert

Jul 23 '05 #2
Thanks, you have provided the answer I thought was true but hadn't seen it
anywhere.
--
Robert
Jul 23 '05 #3

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

Similar topics

0
by: Jeff Levinson [mcsd] | last post by:
I'm an architect for a very large fortune 100 company and we still struggle with the best balance. However, I use a couple of simple guidelines that have worked very well for me in almost all...
2
by: Andy Fish | last post by:
Hi, I an trying to figure out how to use some browser objects like screen, window, parent, document, top etc. These are available as built-in global variables when programming the browser using...
9
by: Aidan | last post by:
I rely heavily on MSDN for documentation when it comes to HTML/DHTML/JavaScript/CSS but as a result I often have problems getting my stuff to work in Netscape/Mozilla/Firefox. I like the MSDN...
1
by: Adie | last post by:
Hi, I'm starting to reuse quite a bit of my code through namespace references and would like that when I view the object in the "object browser" that I can see my comments about the method,...
0
by: sharpener | last post by:
This is a slightly edited re-post with a (hopefully) more descriptive subject and a bit more detail. I'm new to C# and to newsgroups, so please bear with a possibly foolish query. I'll try to...
1
by: geoffblanduk_nospam | last post by:
Does anyone know of any classes that will load the XML documentation into some useful classes? I'm assuming there must be some somewhere as that's what the Object browser does to show summaries...
2
by: rgrandidier | last post by:
I am looking for an example using a summary element to have both a see and seealso tag within the summary to get them to show up as links in the Object Browser. The following is what I am using...
1
by: Stephan Keil | last post by:
Hi all, I am somewhat confused by the Object.GetHashCode() documentation. What I am looking for, is a hash code, which is bound to the _identity_ of an object, not to it's _value_ (see other...
34
by: nicolasfr | last post by:
Hi, I am a bit disapointed with the current Python online documentation. I have read many messages of people complaining about the documentation, it's lack of examples and the use of complicated...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
0
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 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 former...

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.