我按照此tutorial 创建了类库的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“正确”呈现标签?
答案 0 :(得分:1)
请参阅Cross reference .NET BCL types:
在为自己的.NET库创建文档时,需要链接到.NET基类库中的类型。 .NET Framework参考文档不是由DocFX生成的,因此我们为您创建了一个交叉引用映射,以便您可以在项目中使用它来引用.NET BCL类型。
以DocFX自己的文档为例。您可以在docfx.json中使用xref
属性来指定MSDN External Reference:
"xref": [
"../src/nuspec/msdn.4.5.2/content/msdn.4.5.2.zip"
],