471,339 Members | 1,156 Online
Bytes | Software Development & Data Engineering Community
Post +

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 471,339 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 2580
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 discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

reply views Thread by Jeff Levinson [mcsd] | last post: by
1 post views Thread by geoffblanduk_nospam | last post: by
2 posts views Thread by rgrandidier | last post: by
1 post views Thread by Stephan Keil | last post: by
reply views Thread by rosydwin | last post: by

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.