Visual Studio禁用丢失的XML注释警告
我有一个项目有500多个Missing XML Comment
警告。 我知道我可以删除XML注释function,或在任何地方粘贴空的注释片段,但我更喜欢一个通用的解决scheme,我可以做一个更改,禁用此types的所有警告。
我刚刚做的是放
///<Summary> /// ///</Summary>
要么
#pragma warning disable 1591
只是好奇,如果这是可能的。
如上所述,总的来说,我不认为这些警告应该被忽略(压制)。 总之,警告的方法是:
- 通过input1591更改项目“
Properties
>“Build
>“Errors and warnings
>“Suppress warnings
来Suppress warnings
- 添加XML文档标签( GhostDoc可以非常方便)
- 通过编译器选项禁止警告
- 在项目“
Properties
>“Build
>“Output
”中取消选中“XML文档文件”checkbox - 在相应文件的顶部添加
#pragma warning disable 1591
,并在底部添加#pragma warning restore 1591
禁用警告:转到项目属性(右键单击您的项目,然后从上下文菜单中select属性)转到生成选项卡
将1591添加到Suppress警告文本框
进入项目属性并取消选中生成XML文档选项。
重新编译和警告应该消失。
这将是一个评论,但我不能得到它适合的限制:
我很想禁用它们只是为了Reference.cs和WebService导入。 其实我正在使用一个macros来做一个文件。 只要打开文件并执行这个macros(在VS2010中testing):
Sub PragmaWarningDisableForOpenFile() DTE.ActiveDocument.Selection.StartOfDocument() DTE.ActiveDocument.Selection.NewLine() DTE.ActiveDocument.Selection.LineUp() DTE.ActiveDocument.Selection.Insert("#pragma warning disable 1591") DTE.ActiveDocument.Selection.EndOfDocument() DTE.ActiveDocument.Selection.NewLine() DTE.ActiveDocument.Selection.Insert("#pragma warning restore 1591") DTE.ActiveDocument.Save() End Sub
有没有办法自动做到这一点? 每当自动生成的代码覆盖文件时,您将不得不重做此操作。