Visual Studio Отключить отсутствующий комментарий XML Предупреждение

У меня есть проект с более чем 500 Missing XML Comment предупреждениями. Я знаю, что могу удалить функцию комментария XML или вставить пустые фрагменты комментариев во всем мире, но я бы предпочел использовать общее решение, в котором я могу сделать одно изменение, которое отключит все предупреждения этого типа.

То, что я сейчас делаю, заключается в размещении

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

или

#pragma warning disable 1591

было просто интересно, если бы это было возможно.

Ответы

Ответ 1

Как было сказано выше, в целом я не думаю, что эти предупреждения следует игнорировать (подавлять). Подводя итог, способы предупреждения будут следующими:

  • Подавить предупреждение, изменив проект Properties > Build > Errors and warnings > Suppress warnings, введя 1591
  • Добавить теги документации XML (GhostDoc может быть весьма кстати для этого)
  • Подавление предупреждения с помощью параметров компилятора
  • Снимите флажок "Файл документации XML" в проекте Properties > Build > Output
  • Добавьте #pragma warning disable 1591 вверху соответствующего файла и #pragma warning restore 1591 внизу

Ответ 2

Отключить предупреждение: Перейдите в свойства проекта (щелкните правой кнопкой мыши на своем проекте и выберите "Свойства" в контекстном меню) Перейдите на вкладку "Сборка" введите описание изображения здесь

Добавить 1591 в текстовое поле "Подавить предупреждения" введите описание изображения здесь

Ответ 3

Перейдите в свойства проекта и снимите флажок сгенерировать XML-документ.

Отменить файл документации XML

Перекомпилируйте и предупреждения должны исчезнуть.

Ответ 4

Это был бы комментарий, но я не смог бы его ограничить:

Я хотел бы отключить их только для импорта Reference.cs и WebService. На самом деле я использую макрос, чтобы сделать это для файла. Просто откройте файл и выполните этот макрос (протестирован в 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

Нет ли способа сделать это автоматически? Вам придется переделывать это каждый раз, когда автоматически сгенерированный код переопределяет файл.

Ответ 5

Вы также можете изменить файл проекта .csproj включив в него <noWarn>1591</noWarn> внутри первой <PropertyGroup>. Родом из Александру Букур Статья Здесь

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