5

It is relatively common practice for property names to default to the type name when the type name is significant enough;

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; }
}

My problem is that the <see cref="User" /> element in the XML documentation refers to the UserSession.User property. What should I write in order to reference the User type instead?

4

2 回答 2

4

Use the full name of the type, including the namespace.

于 2013-06-27T09:37:20.803 回答
3

Write the full name of User as shown in <see> (C# Programming Guide) with System.Console.WriteLine(String):

<see cref="YourNamespace.User"/>
于 2013-06-27T09:41:21.737 回答