Visual Studio Отключение предупреждения об отсутствии комментария XML - PullRequest
Новая
       43

Visual Studio Отключение предупреждения об отсутствии комментария XML

176 голосов
/ 02 ноября 2011

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

Что я делаю сейчасставить 

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

или 

#pragma warning disable 1591

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

Ответы [ 5 ]

282 голосов
/ 16 декабря 2011

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

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

Отключение предупреждения: перейдите в свойства проекта (щелкните правой кнопкой мыши свой проект и выберите «Свойства» в контекстном меню). Перейдите на вкладку «Сборка» enter image description here

Добавьте 1591 кПодавить текстовое поле предупреждений enter image description here

9 голосов
/ 23 сентября 2015

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

Uncheck XML documentation file

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

7 голосов
/ 25 января 2019

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

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    ...
    <noWarn>1591</noWarn>
  </PropertyGroup>
  ...
</Project>
4 голосов
/ 08 мая 2012

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

Я бы хотел отключить их только для импорта 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

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

...