为什么我们在 c# 中使用 class 属性 的描述属性

Question

我在一些代码中看到 class 属性 使用 Description 属性，但我在 C# 编码中找不到行为的原因

 public class sample
    {
        [Description("description1")]
        public string PropertyOnne{ get; set; }

     }

为了代码的可读性，我们甚至可以对 属性 使用 xml 摘要，我不明白 class 级别的摘要和描述属性之间的区别。

Answer 1

这是给视觉设计师的，他们可以在引用它们时显示描述。

文档注释：

A visual designer can display the specified description when referencing the component member, such as in a Properties window. Call Description to access the value of this attribute.

来源：https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.descriptionattribute?view=netframework-4.7.2

Answer 2

简单的话，可以考虑下面的解释

• 该标签用于在编译时为您的项目在 XML 中生成文档，这也被 visual studio 用于其智能感知数据库

• 设计者为了理解文字而使用的Description属性，多在属性window的底部（供参考）。