引用文件的XML注释

本文关键字:XML 注释 文件 引用文 引用 | 更新日期: 2023-09-27 18:05:14

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

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

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

引用文件的XML注释

在Sandcastle中路径是相对于工作文件夹(.'Working文件夹下的输出路径设置在设置中)。要指定相对于项目的路径,请使用{@ProjectFolder}作为前缀。例如:

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

你可以在这里找到一个完整的替换标签列表:

自定义构建过程-替换标签


你知道你可以用href代替cref在文档标签:

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