如何在文档注释中使用自定义链接文本创建代码引用？

我正在将应用程序库从Java移植到C＃。在Java文档中，有些地方使用自定义文本链接到特定的代码引用。例如：如何在文档注释中使用自定义链接文本创建代码引用？

Suffix --&gt; {@link DataOutput#writeString String}

我使用XML文档注释类似的方法试过......

Suffix --&gt; <see cref="DataOutput.WriteString(string)">String</see>

...但整个链路只是从两个智能感知和生成的文档消失时，我尝试它那样。问题是，如何使用C＃中的.NET XML文档注释来构建具有自定义文本的类似代码链接？如果无法执行此操作，建议的解决方法是什么？

如果重要，我们正在试验使用DocFx代码生成器。

来源

2017-06-21 NightOwl888

看一看沙堡，它能够从你的XML的文档生成HTML-帮助文档（除了一些人也）。但是VS不能像Eclipse那样处理到其他类型或成员的链接。 – HimBromBeere

DocFX支持这些注释以生成链接。它也用于其源代码，如[this]（https://github.com/dotnet/docfx/blob/1a191f6f1853e48873d5f45003cda669d3df0cca/src/Microsoft.DocAsCode.Dfm/IDfmEngineCustomizer.cs#L11）。引用的方法是否也由DocFX构建？ – Yuby

@Yuby - 您引用的链接有一个*标准代码链接*，它使用代码元素的名称作为链接文本（在本例中为'DfmEngineBuilder'）。我所问的是将链接文本变成除引用的代码元素的名称以外的内容，例如“我的自定义文本”（因为它是在正在移植的代码中以这种方式完成的）。 – NightOwl888

您可以使用DocFX的交叉引用语法：[String](xref:DataOutput.WriteString(System.String))。

参见：http://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#different-syntax-of-cross-reference

来源

2017-07-18 13:49:16 Yuby

或者“@”DataOutput.WriteString（System .String）？文本字符串=“' – bitbonk

如何在文档注释中使用自定义链接文本创建代码引用？

回答

相关问题