Docfx引用-不解析(见标记)

Question

我遵循这个教程为类库创建了一个API文档。

在类库的注释中，我使用了“请参阅”标记来引用其他类型。

例如，这是包含System.Action扩展方法的类的注释

/// <summary>
///     Class containing some extension methods for <see cref="Action" />.
/// </summary>
public static partial class ActionEx

docfx为上面的注释创建以下YAML源：

summary: "\n    Class containing some extension methods for <xref href=\"System.Action\" data-throw-if-not-resolved=\"false\"></xref>.\n"

最后的HTML输出包含相同的字符串：

Class containing some extension methods for <xref href="System.Action" data-throw-if-not-resolved="false"></xref>.

​

​

我希望docfx要么创建对System.Action的引用，要么忽略标记。

如何使docfx呈现标签“正确”？

Answer 1

请参阅交叉参考.NET BCL类型

在为您自己的.NET库创建文档时，需要链接到.NET基类库中的类型。.NET框架参考文档不是由DocFX生成的，因此我们为您创建了一个交叉引用映射，以便您可以在项目中使用它来引用.NET BCL类型。

以DocFX自己的文档为例。您可以发现它使用xref属性在docfx.json中指定MSDN外部参考

"xref": [
  "../src/nuspec/msdn.4.5.2/content/msdn.4.5.2.zip"
],