2016-10-02 29 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" 
],