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

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