Embedding External URLs or Hyperlinks within XML Comments

Question

As a usual part of development, I hit the internet and read and read before I code and code... I would like to be able to credit those from whom I have learned so much by embedding hyperlinks to the sources of my newfound knowledge right in my XML Comments.

 

I am looking for guidance on which XML Comments tag or techinque would be the most appropriate place to accomplish my goal.  For example, I have been reading up on Database Factory Patterns of late, I'd like to be able to credit David Hayden with something like:

 

/// <MoreInfoAt url="http://codebetter.com/blogs/david.hayden/articles/59642.aspx"/>

 

Obviously, the above line is psuedo-code... how do you do it right and well?

Answer 1

Hi,

 

To insert an external hyperlink, do just as you do in an html file. For example in your scenario, you can add the credit like this:

/// <summary>     /// This is a test class.See <a href="http://codebetter.com/blogs/david.hayden/articles/59642.aspx">Credits</a>.     /// </summary>

 

And a help documentation tool such as SandCastle will process it properly. The output in the help file would be as this:

This is a test class. See credits.

 

Most help files are of html format so it is not hard to understand.  However the tools in VS IDE may not recognize it.

 

Best Regards

Chunsheng Tang

 

 

Answer 2

My Sincere thank to Chunsheng and all of you who assist all of us.