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

Question

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

Suffix --> {@link DataOutput#writeString String}

我尝试在XML文档注释中使用类似的方法......

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

...但是当我以这种方式尝试时，整个链接都从Intellisense和生成的文档中消失了。问题是，如何使用C＃中的.NET XML文档注释构建与自定义文本类似的代码链接？如果没有办法，建议的解决方法是什么？

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

Answer 1

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

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