c# - 如何评论 Visual Studio 智能感知类的属性？

Question

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

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

我想知道是否有比 /// 更简单的方法来评论智能感知的类属性，而 /// 最少 3 行。

Answer 1

它只是 XML。如果你愿意，你可以在一行中完成。

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

Answer 2

您可以使用GhostDoc，它会自动生成一些简单但有用的评论。

Answer 3

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

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