C# XML Documentation Website Link

Viewed 59804

Is it possible to include a link to a website in the XML documentation? For example, my method's summarized as

///<Summary>
/// This is a math function I found HERE.
///</Summary>
public void SomeMathThing(Double[] doubleArray)
{
   ...
}

and when I type

SomeMathThing(

I want IntelliSense to show the summary with the option to click on "HERE" to link to an outside website. Is this possible? How would it be done?

6 Answers

Use the <a> tag. For example, I used this solution in my project:

Result:

My XML code:

/// <summary>
/// This is C# XML Documentation Website Link
/// <a href="https://stackoverflow.com/questions/6960426/c-sharp-xml-documentation-website-link">See more</a>
/// </summary>

Or use the <see> tag. Result is the same to the <a> tag.

/// <summary>
/// This is C# XML Documentation Website Link
/// <see href="https://stackoverflow.com/questions/6960426/c-sharp-xml-documentation-website-link">See more</see>
/// </summary>

I also tried <see href="https://some.com/> first and it did not work; however, I then tried <seealso href="https://some.url/"> and it did work.

Related