CODEWITHSUNDEEP
c#xml-comments
imodin
imodin

Reputation: 821

XML comments - refer to property in class

How describe in XML comments that property Encoding is intiliaze to default.

public class Settings
{
    public Encoding Encoding{get;set;}

        /// <summary>
        /// Initialize a new instance of a <c>HttpRequestSettings</c> type.
        /// </summary>
        /// <remarks>
        ///     <para>
        ///         How refer to property Encoding in class and describe that property Encoding is set do default ????
        ///     </para>
        /// </remarks>
        public Settings()
        {
            Encoding = Encoding.Default;
        }
}

Upvotes: 0

Views: 337

Answers (1)

Jeppe Stig Nielsen
Jeppe Stig Nielsen

Reputation: 61952

Use:

/// ...
/// This constructor sets <see cref="Encoding"/> to its default value.
/// ...

Does it lead to any problems? I believe the member (property) should have higher "priority" than the type (class) which is not nested in the current class.

Upvotes: 1

Related Questions