2016-10-02 27 views
0

我按照此tutorial为类库创建API文档。Docfx 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>. 

Website

我希望docfx可以创建一个参考System.Action或忽略标记。

如何让docfx呈现标记“正确”?

回答

1

参考Cross reference .NET BCL types

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

以DocFX自己的文档为例。你可以找到它xref财产docfx.json来指定MSDN External Reference

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