参考通用评论

时间:2009-05-30 23:00:27

标签: c# visual-studio intellisense xml-comments xml-documentation

我想知道是否可以在注释中引用动态泛型类名并在IDE中有条件地解析它?

简单的基类示例:

// <summary>
// Retrieves all <T> members from the database.
// </summary>
public void GetAll<T>()
{
 //magic
}

如果我现在从这个类继承并且碰巧是用户类,那么我想让IntelliSense将我的评论显示为“从数据库中检索所有用户成员”。

这可能吗?

1 个答案:

答案 0 :(得分:4)

无法让Intellisense自动编写用于特定呼叫的泛型类型的名称。您可以做的最好的事情是使用typeparamref标记,它指示Visual Studio(更重要的是任何文档生成器),您指的是泛型类型参数(在本例中为T)。

// <summary>
// Retrieves all <typeparamref name="T"/> members from the database.
// </summary>
public void GetAll<T>()
{
    //magic
}