2011-11-02 32 views
132

私は500を超えるMissing XML Commentのプロジェクトを持っています。 XMLコメント機能を削除したり、空のコメントスニペットを貼り付けることができますが、このタイプのすべての警告を無効にする変更を加えることができる汎用ソリューションが好まれます。それが可能ならば、私はちょうど今Visual Studio欠落しているXMLコメントを無効にする警告

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

または

#pragma warning disable 1591 

を入れているん何

はちょうど興味がありました。

+3

実際の質問は何ですか? XMLコメントが見つからないときに生成される警告を無効にする別の方法を知りたいですか?プロジェクトのプロパティで、[ビルド]タブに変更し、[XMLドキュメントファイル]をオフにします。しかし、私は警告を抑制するのではなく、不足しているドキュメントを追加することをお勧めします。 – Gorgsenegger

+0

それは絶対に正しいですが、私がこれを初めて知ったときに私が1つの場所からこれを解決できるかどうか不思議でした。 –

+0

これらに関する質問は助けることがあります。 http://stackoverflow.com/questions/11444631/how-to-disable-a-particular-compiler-warning-for-a-particular-file ます。http: //stackoverflow.com/questions/3630282/vs2010-autogenerated-files-and-xml-documentation – Mightymuke

答えて

217

一般に、私はこれらの警告を無視(抑制)する必要はないと考えています。要約すると、警告を回避する方法は、次のようになります。

  • は1591
  • は、XML文書のタグを追加入力することにより、プロジェクトProperties>Build>Errors and warnings>Suppress warningsを変更することで警告を抑制する(GhostDocはのために非常に便利ですそれは)
  • は、コンパイラオプション
  • のチェックを外し、プロジェクト内の "XMLドキュメントファイル" チェックボックスを経由して警告を抑制しますProperties>Build>Output
  • これはコメントされているだろうが、私はそれが限界に合うように得ることができませんでした下
  • でそれぞれのファイルと #pragma warning restore 1591の上部に
+112

GhostDocを使用しないでください。メソッド名からコメントを推論することができれば、人間はそれをよりよく推測することができます。これにより、ゼロ値が追加されます。その時は、よく名づけられた方法をお祝いしたほうがいいでしょう。 – JRoughan

+18

私は同意しなければならない、GhostDocは、必要なパラメタのリストと返信タグ(メソッドが無効でない場合)をすばやく追加するのに役立ちます。私はそれを使用して好きですし、他にもやっている人がかなりいます。ただし、要約の説明には編集が必要な場合がありますが、このような場合にはほとんどの自動化が重要です。 – Gorgsenegger

+19

すべての場合、プレースホルダを追加するだけで時間が節約できますが、開発者が生成されたテキストをどこに残しているのかわかっているコードベースの数は、使用するには十分に成熟していないと思います。コメントは自己文書化されていないコードのための(しばしば必要な)松葉杖であり、ショートカットを提供することにより、このツールは世界のコードに負の純利益をもたらす。 – JRoughan

4

#pragma warning disable 1591を追加します。

私はそれらを無効にするのが大好きです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 

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

+2

私は、この警告は自動生成されたコンテンツには表示されるべきではないと思うかもしれません。おそらくプロジェクトのプロパティの対応する設定を確認する必要があります。 – Gorgsenegger

+1

いいえ、XML-Comment警告を有効にするだけですべてが表示されます。また、自動生成されたコードの場合にのみ無効にするオプションはありません。そのため、コードを再生成する必要があるときに切り詰められます。 – Kjellski

+0

プロジェクトプロパティの 'Code Analysis'には、'生成されたコードからの結果を排除する 'オプションがあります。各コードの再生成後にマクロを再実行することは、実際にはIMOの解決策ではありません。上記のオプションがうまくいかない場合は、代わりにプラグマディレクティブを自動的に追加するようにコードジェネレータを調整できますか? – Laoujin

6

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

Uncheck XML documentation file

再コンパイルと警告が離れて行く必要があります。

+1

これは、XMLドキュメントを生成する必要がなく、XMLコメントが検証されないことに気をつけない限り、良いアプローチです。 – Keith

+0

自動生成されていないファイルからの警告を保持したい場合は、これは機能しません。警告のサブセットを取り除くためだけにすべての警告を削除することは、私に少し残酷すぎるようです。さらに、ほとんどの企業では、自動生成コードを含まないすべてのファイルに実際にXMLコメントを作成するのが一般的です。また、ユーザーは単にXMLコメント機能を削除しないだけの解決策を求めていたので、この質問には答えません。 – SubliemeSiem

33

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

が抑制警告のテキストボックスに1591を追加し enter image description here

+2

「S125、CS1591、S1172」というカンマで区切られたリストを持つ魅力のように機能します。ビルドの後、戦闘は消えた。 – AFD

関連する問題