如何为Visual Studio intellisense评论类的属性?

时间:2013-01-24 20:45:20

标签: c# visual-studio intellisense

我知道使用///来评论函数是正确的方法,它也适用于属性,如下面的代码所示

/// <summary>
/// This is for demo
/// </summary>
public class Foo
{
    /// <summary>
    /// Description A (working for intellisense)
    /// </summary>
    public int iA { get; set; }

    /// Description B (not working for intellisense)
    public int iB { get; set; }

    public int iC { get; set; }
}

enter image description here

我想知道是否有更简单的方法来注释intellisense的类属性而不是///最少3行。

3 个答案:

答案 0 :(得分:9)

这只是XML。如果您愿意,可以在一行中完成。

/// <summary>Description A (working for intellisense)</summary>
public int iA { get; set; }

答案 1 :(得分:2)

你可以GhostDoc自动生成一些简单但有用的评论。

答案 2 :(得分:1)

文档中属性的推荐标记是&lt; value&gt;根据官方.NET指南 https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/value

/// <value>The Name property gets/sets the value of the string field, _name.</value>