如何在Intellisense和DocFx中显示XML注释中see cref的内容?

4

我已经在一个列表属性上使用了XML注释, 该属性的类型是List。

然而,当我将鼠标悬停在该属性上时,Visual Studio显示它为List<T>

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

我尝试了之前帖子中推荐的解决方案,但它并不起作用。

以下是XML注释和C#代码供您参考:

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

我能在XML注释中做些什么,以便我可以在智能感知和文档中看到 List<ClassXXXX>?谢谢。
1个回答

3

在<see>标记中明确设置您想要的文本:

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

在 cref 属性中无法直接指定 List<ClassXXXX>。cref 是对类型定义及其文档的引用。没有类型 List<ClassXXXX>,也没有相关文档。只有 List<T> 可以创建一个链接。但链接文本可以是任何你需要的内容。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接