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, Jul 07 '11 at 11:01

score 2 · Answer 1 · answered May 11 '12 at 16:44

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>...

score 1 · Answer 2 · answered Jan 08 '12 at 12:01

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 08 '12 at 12:01

rene

41,474
78
114
152

Sad thing is, this only seems to work for non-generic types. Generic types have a mangled ID. – Joey Mar 21 '17 at 09:22

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

2 Answers2