C# Docfx API参考-不解析see标记
我按照这个步骤为类库创建了一个API文档 在我的类库的注释中,我使用see标记来引用其他类型。C# Docfx API参考-不解析see标记,c#,documentation-generation,xml-documentation,docfx,C#,Documentation Generation,Xml Documentation,Docfx,我按照这个步骤为类库创建了一个API文档 在我的类库的注释中,我使用see标记来引用其他类型。 例如,这是包含System.Action的扩展方法的类的注释: // ///类,该类包含的扩展方法。 /// 公共静态部分类ActionEx docfx为上述注释创建以下YAML源: summary: "\n Class containing some extension methods for <xref href=\"System.Action\" data-throw-if-no
例如,这是包含System.Action的扩展方法的类的注释:
//
///类,该类包含的扩展方法。
///
公共静态部分类ActionEx
docfx为上述注释创建以下YAML源:
summary: "\n Class containing some extension methods for <xref href=\"System.Action\" data-throw-if-not-resolved=\"false\"></xref>.\n"
summary:“\n包含的某些扩展方法的类。\n”
最终HTML输出包含相同的字符串:
Class containing some extension methods for <xref href="System.Action" data-throw-if-not-resolved="false"></xref>.
类,其中包含的扩展方法。
我希望docfx创建对System.Action的引用或忽略标记
如何使docfx“正确”呈现标记?请参阅:
为自己的.NET库创建文档时,需要链接到.NET基类库中的类型。.NET Framework引用文档不是由DocFX生成的,因此我们为您创建了一个交叉引用映射,以便您可以在项目中使用它来引用.NET BCL类型
以DocFX自己的文档为例。您可以在中找到使用xref
属性来指定:
Class containing some extension methods for <xref href="System.Action" data-throw-if-not-resolved="false"></xref>.
"xref": [
"../src/nuspec/msdn.4.5.2/content/msdn.4.5.2.zip"
],