参考文件的XML注释

时间:2013-03-22 14:32:28

标签: c# xml comments

我想将文件的引用添加到类的xml注释中。我可以这样做:

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

如何使用文件的相对路径?

1 个答案:

答案 0 :(得分:1)

在Sandcastle路径中,相对于工作文件夹(设置中设置的输出路径下的.\Working文件夹)。要指定相对于项目的路径,请在其前面添加{@ProjectFolder}。例如:

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

您可以在此处找到此类替换标签的完整列表:

  

Customizing the Build Process - Replacement Tags


您知道吗,您可以在文档标记中用cref替换href

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

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