Visual Studio Disabling Missing XML Comment Warning

Visual Studio-2010Xml Comments

Visual Studio-2010 Problem Overview


I have a project with over 500 Missing XML Comment warnings. I know I can remove the XML Comment feature, or paste empty comment snippets everywhere, but I'd prefer a generic solution where I can make one change that disables all warnings of this type.

What I do just now is putting

///<Summary>
/// 
///</Summary>

or

#pragma warning disable 1591

was just curious if it would be possible.

Visual Studio-2010 Solutions


Solution 1 - Visual Studio-2010

As suggested above, in general I don't think that these warnings should be ignored (suppressed). To summarise, the ways around the warning would be to:

  • Suppress the warning by changing the project Properties > Build > Errors and warnings > Suppress warnings by entering 1591
  • Add the XML documentation tags (GhostDoc can be quite handy for that)
  • Suppress the warning via compiler options
  • Uncheck the "XML documentation file" checkbox in project Properties > Build > Output
  • Add #pragma warning disable 1591 at the top of the respective file and #pragma warning restore 1591 at the bottom

Solution 2 - Visual Studio-2010

Disable the warning: Go to the Project properties(Right click on your project and choose Properties from the context menu) Go to the Build tab enter image description here

Add 1591 to the Suppress warnings textbox enter image description here

Solution 3 - Visual Studio-2010

You can also modify your project's .csproj file to include a <noWarn>1591</noWarn> tag inside of the first <PropertyGroup>. Originally from Alexandru Bucur's Article Here

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    ...
    <NoWarn>1591</NoWarn>
  </PropertyGroup>
  ...
</Project>

Solution 4 - Visual Studio-2010

Go into project properties and uncheck the generate XML document option.

Uncheck XML documentation file

Recompile and the warnings should go away.

Solution 5 - Visual Studio-2010

This would have been a comment but I couldn't get it to fit the limitation:

I would love to disable them just for the Reference.cs and WebService imports. Actually, I'm using a macro to do it for a file. Just open the file and execute this macro (tested in VS2010):

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

There is really no way to do this automatically? You would have to redo this every time the auto-generated code overrides the file.

Solution 6 - Visual Studio-2010

Visual Studio 2022:

I would recommend to use .editorconfig file in the Visual Studio to set a common code style across all solution.

In this case, just add this code manually to the .editorconfig file:

# SA0001: XML comment analysis is disabled due to project configuration
dotnet_diagnostic.SA0001.severity = none

NOTE: For me, suppressing SA0001 from the Editor Config designer not working.

Only manual setting rule in the file.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionNivid DholakiaView Question on Stackoverflow
Solution 1 - Visual Studio-2010GorgseneggerView Answer on Stackoverflow
Solution 2 - Visual Studio-2010Rao AdnanView Answer on Stackoverflow
Solution 3 - Visual Studio-2010DotNetPadawanView Answer on Stackoverflow
Solution 4 - Visual Studio-2010ChrisView Answer on Stackoverflow
Solution 5 - Visual Studio-2010KjellskiView Answer on Stackoverflow
Solution 6 - Visual Studio-2010Vladislav HorbachovView Answer on Stackoverflow