我可以在构造函数注释中引用属性注释吗?

时间:2015-12-08 06:41:46

标签: c# xml comments

如果我的类有一个注释的公共属性(通过构造函数赋值),我可以从具有相同名称的构造函数参数的描述中引用它的描述吗?

public class MyClass
{
    /// <summary>
    /// x description
    /// </summary>
    public int x { get; private set; }
    /// <summary>
    /// y description
    /// </summary>
    public int y { get; private set; }
    /// <summary>
    /// Constructor description
    /// </summary>
    /// <param name="x">How do I reference x description from here?</param>
    /// <param name="y">And y description?</param>
    public MyClass(int x, int y)
    {
        this.x = x;
        this.y = y;
    }
}

1 个答案:

答案 0 :(得分:8)

您无法包含说明,但您可以使用<see>标记链接到属性文档。例如:

<param name="x">The initial value for <see cref="x"/></param>

顺便说一句,我强烈建议您遵循.NET命名约定,其中公共成员以大写字母开头。