如何强制文档<;参见/>;元素引用类型,而不是引用具有相同名称的属性

本文关键字:引用 属性 参见 lt 文档 何强制 gt 引用类型 元素 | 更新日期: 2023-09-27 18:20:09

当类型名称足够重要时,属性名称默认为类型名称是相对常见的做法;

public class User { }
public class UserSession
{
    /// <summary>
    /// Creates a <see cref="UserSession" /> instance
    /// with the given <see cref="User" />
    /// </summary>
    public UserSession(User user)
    {
        User = user;
    }
    public User User { get; private set; }
}

我的问题是XML文档中的<see cref="User" />元素引用了UserSession.User属性。我应该写些什么来引用User类型?

如何强制文档<;参见/>;元素引用类型,而不是引用具有相同名称的属性

使用类型的全名,包括命名空间。

System.Console.WriteLine(String):编写<see>(C#编程指南)中所示的用户全名

<see cref="YourNamespace.User"/>