如何為Visual Studio intellisense評論類的屬性？

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

我想知道是否有更簡單的方法來注釋intellisense的類屬性而不是最小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>The Name property gets/sets the value of the string field, _name.</value>