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


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

то, что я сейчас делаю, это положить

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

или

#pragma warning disable 1591

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

4 153

4 ответа:

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

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

отключить предупреждение: Заходим в свойства проекта(Правой Кнопкой Мыши на проекте и выберите Свойства из контекстного меню) Перейдите на вкладку сборка enter image description here

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

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

Uncheck XML documentation file

перекомпилировать и предупреждения должны уйти.

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

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

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