添加注释到Settings.Designer.cs

Question

我在 Visual Studio 2008 项目中使用 .Settings 文件，该文件会从 PublicSettingsSingleFileGenerator 自定义自动生成 Settings.Designer.cs 文件工具。

这工作正常，但我还想在编译选项中启用“警告为错误”，以强制每个人保持 XML 注释是最新的，但我不知道如何向自动中的所有元素添加注释- 生成的代码。

通过在设计视图中选择元素并在属性窗口中添加“说明”，可以为实际属性添加注释。但似乎没有办法对类声明或默认实例属性执行此操作。

重现此问题的步骤如下

1. 创建一个新项目
2. 将设置文件添加到项目
3. 将设置文件的“访问修饰符”设置为公共
4. 转到项目属性，构建部分
5. 将“将警告视为错误”设置为全部
6. 检查输出XML 文档文件选项
7. 构建解决方案

，这是在 PublicSettingsSingleFileGenerator Settings.Designer.cs 文件中生成的代码

namespace SettingsTest {

    [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "9.0.0.0")]
    public sealed partial class Settings1 : global::System.Configuration.ApplicationSettingsBase {

        private static Settings1 defaultInstance = ((Settings1)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings1())));

        public static Settings1 Default {
            get {
                return defaultInstance;
            }
        }
    }
}

不确定此额外信息是否应该成为问题部分的一部分，因为它以某种方式指向回答

根据此链接，应用于该类的属性似乎是错误的。

http://blogs.msdn.com/b/codeanalysis/archive/2007/04/27/ Correct-usage-of-the-compiler generatedattribute-and-the- generatedcodeattribute.aspx

“CompilerGenerateAttribute< /strong> - 此属性仅供编译器使用，并指示特定的代码元素是编译器生成的，无论如何都不应在源代码中使用。”

“GeneratedCodeAttribute - 此属性供生成代码的自定义工具使用。它只能应用于一遍又一遍地重新生成的代码，并且不应由用户期望的模板使用如果生成的类型是分部类，则它也不应该在类型级别应用。在这种情况下，它应该仅应用于包含在类型的生成部分中的各个成员。”

更新

我已在 Microsoft Connect 网站上提出了一个错误报告，并将在获得更多信息后进行更新并接受答案 http ://connect.microsoft.com/VisualStudio/feedback/details/634692/publicsettingssinglefilegenerator-code-fails-when-treat-warnings-as-errors-is-set-to-all-and-xml-documentation-is-on

Answer 1

没有好的方法可以做到这一点，您无法在自动生成的文件中注入#pragma warning禁用。顺便说一句，Winforms 设计器文件也存在问题。项目+属性，构建选项卡，抑制警告= 1591。但这也会在您可能希望打开诊断的地方禁用诊断。 #pragma 警告恢复并不能解决这个问题。

Answer 2

不幸的是，这里存在冲突的问题\设置：

• XML 文档生成将对公共成员的所有缺失评论发出警告。
• 您已打开“将警告视为错误”（这是一件好事）。
• 关于您无法更改的类（即生成的设置）发出警告。

这样做的结果是您的警告被转换为无法修复的编译器错误。您无法可靠地将注释手动添加到设置类，因为下次重新生成类时它们将丢失。

考虑将您的设置放在单独的项目中，并关闭该项目上的 XML 文档。

Answer 3

设置是一个部分类：创建第二个空部分并对其进行注释。

Answer 4

参阅在 Visual Studio 2010 中记录 (XML) 应用程序设置

请 每个设置的描述属性，这将反过来在生成的代码中创建 XML 注释。在 VS2010 中测试可以正常工作。