XML注释 - 引用类中的属性

时间:2013-08-10 14:08:59

标签: c# xml-comments

如何在XML注释中描述属性Encoding是intiliaze为默认值。

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

1 个答案:

答案 0 :(得分:1)

使用:

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

是否会导致任何问题?我相信成员(属性)应该比没有嵌套在当前类中的类型(类)具有更高的“优先级”。