web-dev-qa-db-ja.com

不足しているXMLコメント警告を無効にするVisual Studio

500を超えるMissing XML Comment警告があるプロジェクトがあります。 XMLコメント機能を削除するか、空のコメントスニペットをどこにでも貼り付けることができることは知っていますが、このタイプのすべての警告を無効にする1つの変更を加えることができる汎用ソリューションを希望します。

私が今やっていることは

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

または

#pragma warning disable 1591

それが可能かどうか興味がありました。

visual-studio-2010xml-comments
179
Nivid Dholakia

上で提案したように、一般に、これらの警告は無視される（抑制される）とは思いません。要約すると、警告を回避する方法は次のとおりです。

  • 1591と入力して、プロジェクトProperties> Build> Errors and warnings> Suppress warningsを変更して、警告を抑制します
  • XMLドキュメントタグを追加します（ GhostDoc は非常に便利です）
  • コンパイラオプションを介して警告を抑制する
  • プロジェクトの[XMLドキュメントファイル]チェックボックスをオフにしますProperties> Build> Output
  • #pragma warning disable 1591をそれぞれのファイルの上部に追加し、#pragma warning restore 1591を下部に追加します
288
Gorgsenegger

警告を無効にします：プロジェクトのプロパティに移動します（プロジェクトを右クリックして、コンテキストメニューから[プロパティ]を選択します）[ビルド]タブに移動します enter image description here

[警告を表示しない]テキストボックスに1591を追加します enter image description here

64
Rao Adnan

プロジェクトの.csprojファイルを変更して、最初の<noWarn>1591</noWarn>内に<PropertyGroup>タグを含めることもできます。元々 アレクサンドル・ビュールの記事はこちら

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

プロジェクトプロパティに移動し、[XMLドキュメントの生成]オプションをオフにします。

Uncheck XML documentation file

再コンパイルすると、警告は消えます。

9
Chris

これはコメントになりますが、制限に合うように取得できませんでした。

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

これを自動的に行う方法は本当にありませんか？自動生成されたコードがファイルをオーバーライドするたびに、これをやり直す必要があります。

4
Kjellski