How can I link to MSDN/official documentation from my C# XML documentation comments?

Question

Given an XML comment on a class something like this:

///<summary>Handles the AuthenticateRequest event in the ASP.NET page request lifecycle to authenticate users.</summary>
///<remarks>
///<para>This module will authenticate users based on cookies, form posts, or an impersonation request from the  admin system.</para>
///<para>If authentication succeeds, both the <see cref="System.Threading.Thread.CurrentPrincipal" /> and the <see cref="System.Web.HttpContext.User"/> property are set to an instance of <see cref="MyPrincipal"/> representing the authenticated user.</para>
///</remarks>

How can I get the references to System.Threading.Thread.CurrentPrincipal and System.Web.HttpContext.User to link to the appropriate pages in the framework documentation?

What software are you using to process your XML documentation into real help pages? — Rowland Shaw
– Rowland Shaw, Commented Jul 7, 2011 at 11:01

Mrchief · Accepted Answer · 2012-05-11 16:44:53Z

2

You can use href tag to link to MSDN (or any other source for that matter) and do something like this:

... both the <see href="http://msdn.microsoft.com/en-us/library/system.threading.thread.currentprincipal.aspx">System.Threading.Thread.CurrentPrincipal</see>...

answered May 11, 2012 at 16:44

Mrchief

76.4k20 gold badges145 silver badges193 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

rene · Accepted Answer · 2012-01-08 12:01:41Z

1

Based on this url, the msdn url cheatsheet

and these two experiments applying the things learned from the cheatsheet

link to 1.1 version of frameworkclass

System.Threading.Thread.CurrentPrincipal

link to 4.0 version of frameworkclass

System.Threading.Thread.CurrentPrincipal

answered Jan 8, 2012 at 12:01

rene

42.6k78 gold badges122 silver badges166 bronze badges

1 Comment

Joey Over a year ago

Sad thing is, this only seems to work for non-generic types. Generic types have a mangled ID.

Collectives™ on Stack Overflow

How can I link to MSDN/official documentation from my C# XML documentation comments?

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related