Resources.Designer.cs中的XML注释?

时间:2009-07-02 09:15:16

标签: c# .net visual-studio-2008 resources xml-comments

在我的Visual Studio 2008项目中,我有一个包含图像和字符串的Resources.resx项目。为了强迫自己和其他人写至少 XML注释,我在项目属性的构建选项卡中启用了XML注释的生成。现在,如果有未记录的类,方法,Visual Studio会给我一些警告......这太棒了!

但是,自动生成的Resources.Designer.cs中的所有图像都没有任何XML注释(而字符串都是这样),所以我得到了几个编译器警告缺少XML注释,我实际上无法做任何事情,因为对该文件的更改可能会被覆盖。

有没有机会

  • 告诉编译器忽略设计器生成的代码中的XML注释,或
  • 强制Visual Studio 2008将资源注释写入生成的代码?

感谢任何提示!

2 个答案:

答案 0 :(得分:2)

您可以使用custom tool为.resx文件生成designer.cs文件。自定义工具会调用 resgen.exe 生成.cs文件,然后使用 #pragma 语句包围内容,以忽略错误xml注释的警告:

#pragma warning disable 1591
...
#pragma warning enable 1591

答案 1 :(得分:1)

Visual Studio 应该这样做,但事实并非如此,所以让你的文件像这样:

#pragma warning disable 1591
<contents go here ...>
#pragma warning enable 1591