繁体   English   中英

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

[英]How to comment properties of a class for 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; }
}

在此输入图像描述

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

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

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

您可以使用GhostDoc自动生成一些简单但有用的注释。

根据官方.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> 

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM