XML comment with reference to file

Question

I want to add reference to file to xml comment for class. I can do it so:

/// <summary>
/// Condition with the content of the text <a href="file:///d:/a.jpg">file</a>
/// </summary>

How I can to use relative path to file?

I can recommend considering how links are defined in <a> xml nodes (absolute and relative) here and then try to incorporate them in source code xmlnews.org/docs/xml-basics.html — Ilya Ivanov
– Ilya Ivanov, Commented Mar 22, 2013 at 14:38

Daniel A.A. Pelsmaeker · Accepted Answer · 2013-03-22 14:47:43Z

1

In Sandcastle paths are relative to the working folder (the .\Working folder under the output path set in the settings). To specify a path relative to your project, prefix it with {@ProjectFolder}. For example:

<a href="{@ProjectFolder}/a.jpg">File</a>

You can find a complete list of such replacement tags here:

Customizing the Build Process - Replacement Tags

Did you know you can replace cref with href in the documentation tags:

<see href="http://www.example.com/">Example</see>

<seealso href="http://www.example.com/">Example</seealso>

edited Mar 22, 2013 at 14:47

answered Mar 22, 2013 at 14:42

Daniel A.A. Pelsmaeker

50.8k21 gold badges118 silver badges162 bronze badges

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

Collectives™ on Stack Overflow

XML comment with reference to file

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related