C#中GeneratedCodeAttribute属性的作用是什么？

Question

我使用外部工具生成了一些 C# 代码。 每个生成的类都有一个属性 GeneratedCodeAttribute。 为什么我的生成器要创建这个属性？

Answer 1

设置此属性是因为此代码是由工具生成的，而不是由人工生成的 :) 您可能会问它有什么用处？ MSDN告诉我们：

GeneratedCodeAttribute 类可以被代码分析工具用来识别计算机生成的代码，并提供基于工具和生成代码的工具版本的分析。

Answer 2

第一个链接是它的文档，第二个链接详细描述了它的用途、代码生成器生成它的原因以及代码分析器如何使用它。

http://msdn.microsoft.com/en-us/library/system.codedom.compiler.generatedcodeattribute.aspx

和

https://blogs.msdn.microsoft.com/codeanalysis/2007/04/27/correct-usage-of-the-compilergeneratedattribute-and-the-generatedcodeattribute/

这是否回答你的问题？

Answer 3

生成器最有可能使用它来找回它创建的元素，例如为了执行更新。 如果您修改生成的代码，请注意：根据工具行为，您可能会在进一步更新时丢失修改。

Answer 4

一种潜在用途是某些覆盖工具可以根据指定的属性跳过代码。 您可以告诉 NCover 忽略具有此属性的代码。

Answer 5

这是 Microsoft 博客文章正确使用 CompilerGeneratedAttribute 和 GeneratedCodeAttribute 中的相关文本，以防它最终从他们的网站上消失（这很常见）。

---

CompilerGeneratedAttribute 和 GeneratedCodeAttribute 的正确用法

04/27/2007

Code Analysis、FxCop 和 Code Metrics 都广泛使用 CompilerGeneratedAttribute 和 GeneratedCodeAttribute 来区分用户编写的代码和工具以及编译器生成的代码。

下面描述了这种行为：

Visual Studio 2005 和 FxCop 1.35 中的代码分析

• 工具生成。 对几乎所有工具生成的代码发出警告。 使用算法关闭针对用 GeneratedCodeAttribute 标记并由特定代码生成器生成的代码的特定规则。

Visual Studio 2008 和 FxCop 1.36 中的代码分析

• 工具生成。 如果 Suppress results from generated code 已打开（默认设置），则不会针对标有 GeneratedCodeAttribute 的代码发出警告。

Visual Studio 2008 中的代码度量

• 工具生成。 不显示或生成用 GeneratedCodeAttribute 标记的代码的度量。

不幸的是，Microsoft 内部和外部都存在许多不正确使用这些属性的案例，这篇博文试图让这些属性的正确应用变得更加清晰。

...

生成的代码属性

此属性供生成代码的自定义工具使用。 它应该只应用于一遍又一遍地重新生成的代码，而不应该被用户期望修改的模板使用。 如果生成的类型是分部类，也不应该在类型级别应用它。 在这种情况下，它应该只应用于包含在类型的生成部分中的单个成员。

例如，以下显示了此属性的错误用法（它在类型级别应用于分部类）：

[GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "9.0.0.0" )]
internal sealed partial class Settings : ApplicationSettingsBase
{
    private static Settings defaultInstance = ((Settings)(ApplicationSettingsBase.Synchronized(new Settings())));

    public static Settings Default
    {
        get { return defaultInstance; }
    }
    
    [UserScopedSettingAttribute()]
    [DebuggerNonUserCodeAttribute()]
    [DefaultSettingValueAttribute("")]
    public string MySetting
    {
        get { return ((string)(this["MySetting"])); }
        set { this["MySetting"] = value; }
    }

}

下面显示了该属性的正确用法：

internal sealed partial class Settings : ApplicationSettingsBase
{
    [GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "9.0.0.0" )]
    private static Settings defaultInstance = ((Settings)(ApplicationSettingsBase.Synchronized(new Settings())));
    
    [GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "9.0.0.0")]
    public static Settings Default
    {
    get { return defaultInstance; }
    }
    
    [GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "9.0.0.0")]
    [UserScopedSettingAttribute()]
    [DebuggerNonUserCodeAttribute()]
    [DefaultSettingValueAttribute("")]
    public string MySetting
    {
        get { return ((string)(this["MySetting"])); }
        set { this["MySetting"] = value; }
    }
}