473,392 Members | 1,226 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,392 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 2742
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: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
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: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
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
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,...
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
tracyyun
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...

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.