500以上のMissing XML Comment
警告があるプロジェクトがあります。XMLコメント機能を削除したり、空のコメントスニペットをどこにでも貼り付けたりできることはわかっていますが、このタイプのすべての警告を無効にする1つの変更を加えることができる一般的な解決策を好みます。
私が今やっていることは
///<Summary>
///
///</Summary>
または
#pragma warning disable 1591
それが可能であるかどうかだけに興味がありました。
3
実際の質問は何ですか?XMLコメントが欠落しているときに生成される警告を無効にする別の方法を知りたいですか?プロジェクトのプロパティで[ビルド]タブに変更し、[XMLドキュメントファイル]をオフにします。ただし、警告を抑制しないで、不足しているドキュメントを追加することをお勧めします。
—
Gorgsenegger、2011
それは完全に正しいですが、私がこれに慣れていないので、1つの場所からこれを解決できるかどうかに興味がありました。
—
Nivid Dholakia
これらの関連質問が役立つことがあります。 stackoverflow.com/questions/11444631/...の stackoverflow.com/questions/3630282/...
—
Mightymuke
警告は、他のアセンブリから見えるメンバーに対してのみ表示されます。多くの場合、人々
—
Jeppe Stig Nielsen
public
は正当な理由なしにクラス(およびインターフェース、列挙型など)を作成します。その場合、最も簡単な(そして私の意見では良い)修正は、最も外側の囲み型から単語を削除するpublic
(またはinternal
、優先するスタイルに応じて、冗長なキーワードで置き換える)ことです。その後、このタイプとそのメンバーに関するすべてのCS1591警告が消えます。もちろん、いくつかのタイプを維持する必要があるかもしれませんpublic
。ただし、その場合は、公開部分を適切に文書化する必要があるのは当然です。