相关疑难解决方法(0)

从msdn我得到这个:

#pragma warning disable warning-list
#pragma warning restore warning-list

在示例中,使用了disable和restore.restore如果我想要为整个文件禁用它,是否有必要？

就像,如果我不恢复,它携带多远？之后编译的所有内容都禁用警告吗？或者仅仅是该文件的其余部分？还是被忽略了？

这真的只是重新询问有关Visual Studio 2008的问题.VS2010是否提供任何功能来摆脱自动生成代码的CS1591编译器警告？

CS1591: Missing XML comment for publicly visible type or member

引用VS2008的问题:

这不仅仅是一个问题,而是一个烦恼.我的项目包含许多自动生成的文件(使用mgmtclassgen.exe).当我生成XML文档时,我精美评论的库受到来自这些autogen文件的xml文档警告的困扰.

有没有办法a)抑制生成这些文件的文档或b)抑制警告CS1591只是为了一组文件？我显然不想修改自动生成的文件,即使只是添加抑制编译指示.

编辑:在我的情况下,违规文件由WCF RIA服务生成,因此生成错误的文件是自动生成的WebContext类(MyProject.BusinessApplication.Web.g.cs).

我无法手动修改此文件,因为它是动态生成的,所有更改都将被删除.我也不想全局禁用警告,因为它对我的非自动生成的代码很有帮助.

如果公共成员未记录,C#编译器会显示警告(CS1591):

警告...缺少公开可见类型或成员的XML注释...

这包括所有属性,方法,类,枚举值等.

问题:有没有办法将该类型的警告配置为仅标记未记录的方法？我使用Visual Studio 2010 Ultimate和ReSharper 8.2.

例:

public class MyClass // warning
{
    public MyClass(int x) { ... } // warning

    public void DoSomething() { ... } // warning

    public int MyProp { get; private set; } // prevent this warning
}

public enum MyEnum // warning
{
    X = 0, // prevent this warning
    Y = 1 // prevent this warning
}

背景

我正在开发一个小型编码项目,该项目将被出售给其他公司.我需要为它创建一些文档,所以我决定使用Sandcastle.经过很长时间的下载和安装后,我终于开始工作,并注意到任何没有评论的公共方法或类都有红色文本说明评论缺失.然后我安装了Ghostdoc来帮助加快我的评论速度.这打开了编译器警告缺少xml注释,这很好,因为我现在有一个我需要评论的所有内容的列表.

问题

我的一个代码文件是一个自动生成的文件,其中包含大约3000个编译器警告.我需要能够跳过该文件来创建任何"Missing Xml Comment"编译器警告.我从这篇文章中了解到这些:

• 我知道我可以关闭项目的编译器警告,但项目中还有其他文件应该有编译器警告.
• 我知道我可以#pragma warning disable 1591用来删除编译器警告,但文件是自动生成的,我真的不想每次都要手动重新添加它.
• 我知道我可以添加一个空注释,但是再一次,我真的不想每次重新生成文件时都重新添加它.
• 我可以将文件拉出到它自己的项目中,因为它是它的命名空间中唯一的类,然后删除XML注释要求,但我不希望客户必须处理另一个dll.
• 这些类是局部类,所以我在想试图找到一种方式来添加的#pragma警告禁止在部分类,但即使这是可能的,仍然有将抛出警告枚举.

如何告诉VS忽略特定类型警告的单个文件？

我搜索过并且只发现了想要抑制此警告的人提出的问题,例如Visual Studio禁用缺少XML注释警告,或者如何仅针对某些类型的成员显示它,或者如何将其添加到私有成员.

但是对于我来说,这个警告从来没有在我的任何Visual Studio副本中显示出来......我想要它.直到今天我才知道警告存在.我想记录我的代码,并想知道我没有错过任何地方.

使用上面的链接,我已经完成了在接受的答案中禁用它的建议,并且检查了在我不知情或没有记住的情况下这些都没有完成.

然而,在我近年来使用的Visual Studio的所有副本VS2013 Pro和VS2013 Express以及VS2015社区中都发生了这种情况(或者没有发生).并且在许多项目中都是一样的,包括我从头开始创建的项目以及从其他开发人员继承的项目.

在这些版本中是否需要执行某些操作才能启用它？我很困惑为什么我没有看到它.