如何在Intellisense和DocFx的XML注释中显示内部引用内容?

时间:2019-07-02 09:25:12

标签: c# comments xml-documentation xml-comments docfx

我已经在一种类型为List的属性上使用了XML注释。

但是,当我将鼠标悬停在该属性上时,Visual Studio会将其显示为List<T>

当我使用docFx构建文档时,它仍将注释显示为List<T>而不是List<ClassXXXX>

我在这里尝试过previous post推荐的解决方案,但是它不起作用。

以下是带有C#代码的XML注释供您参考:

/// <summary>
/// Gets and sets the <see cref="List{T}"/> .
/// </summary>
public List<ClassXXXX> ListFoo { get; set; }

我可以在XML注释中做什么,以便可以在智能感知和文档中看到List<ClassXXXX>

谢谢

1 个答案:

答案 0 :(得分:0)

标记中显式设置所需的文本:

/// Gets and sets the <see cref="List{T}">List&lt;ClassXXXX&gt;</see> .

您不能直接在cref属性中指定List 。 cref是对类型定义及其文档的引用。没有类型List ,也没有文档。只有List 可以创建链接。但是链接文本可能是您需要的任何内容。