c# - Docfx API 参考 - 无法解析查看标签

Question

我按照本教程为类库创建 API 文档。

在我的类库的注释中，我使用see标记来引用其他类型。
例如，这是包含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“正确”呈现标签？

score 1 · Accepted Answer

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

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

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

1 回答 1