問題タブ [stylecop]

私は StyleCop を使用しており、私のスタイルに合わない警告を抑制したいと考えています。私は解決策を持っていることを好みます

1) インライン コードの抑制
2) グローバル設定の抑制

私はインターネットを検索しましたが、抑制を行う方法がまだわかりません。

方法 1) の場合、次の行を追加するように言われました。

[アセンブリ: SuppressMessage("Microsoft.Design", "SA1202: すべてのプライベート メソッドは、すべてのパブリック メソッドの後に配置する必要があります", スコープ = "名前空間", ターゲット = "Consus.Client.ClientVaultModule.Services.OnlineDetection")]

しかし、どこでどの名前空間を使用するかについては言及されていません。

2) の方法については、GlobalSuppress ファイルを使用するとのことでしたが、現在、その方法を探すのは簡単ではないようです。

助けてください。

[編集済み] 私の場合、SA1202 に関する警告があります。関連するコードをリージョンにグループ化しているため、すべてのパブリック メソッドの後にすべてのプライベート メソッドを配置する必要があります。特定のメソッドについてのみ、これらの警告を抑制したいと思います。

重複の可能性:
StyleCop 警告を抑制するには?

プライベート/パブリックが混在し、同じリージョンに配置する必要があるメソッドのグループを作成しています (#region を使用)。ここに記載されている方法を使用しましたが、この警告を抑制することはできません。助けてください。

[編集] プロジェクト/ソリューション全体ではなく、この特定の警告のみを抑制する必要があります。でも、やり方を知りたいです^_^

以下のコードは、私が書いたときは問題ないように見えましたが、もう一度戻ってみると、何が起こっているのかを理解するのがかなり困難でした。以前は の周りに括弧がありましvalue == ...たが、StyleCop が必須になった後、それらを削除する必要がありました (これを実際に制御することはできません)。では、コードのこのセクションを改善するにはどうすればよいでしょうか? 私は考えていました：x = value == y ? true : false;、しかしそれはおそらくさらに混乱し、ばかげていますが、コンパイラはそれを最適化します。

StyleCopに、これが中括弧を使用する正しい方法であると言わせることは可能ですか？

しかし、これではありません

またはこれ：

また、if、else、else if、while、foreach、およびforのこの動作も必要です。ただし、クラス宣言やメソッド宣言は対象外です。

一部のコードにStyleCopを追加しSuppressMessageAttributeたいのですが、StyleCopをインストールする必要はありません。

私のプロジェクトはStyleCopバイナリを参照する必要がありますか？参照する場合、どのバイナリを参照しますか？また、StyleCopは？とはSuppressMessageAttribute異なりSystem.Diagnostics.CodeAnalysis.SuppressMessageAttributeますか？

Style-cop .Net コードを使用して特定の .Cs ファイルを解析するにはどうすればよいですか?

長いコメントが必要な場合もあります。これは、長い説明が必要な厄介なハックがある場合に発生する可能性があります。はい、ハッキングを完全に回避/修正することをお勧めしますが、多くの場合、時間的なプレッシャーがあり、将来に先送りする必要があります. その場合、ハックをより良いコードに置き換えようとしている人を含め、詳細なコメントがあると非常に役立ちます。重要なのは、ハッキングが何をしているのか、そしてその理由を正確に理解することです。

多くの場合、複数の段落が必要です。のような空白のコメント//が許可されている場合、コメントはより読みやすくなります。ただし、StyleCopそれらは気に入らず、全体的に同意しているため、すべての提案に固執するようにしています. 今、私は3つのオプションを考えることができます：

(私は通常、コードのセクションをコメントアウトするために二重/三重/四重のコメントを使用するため、最初のコメントは好きではありません)。

(私は 2 番目のオプションが好きではありません。ちょっとばかげていると思います)

(私は 3 番目のオプションも好きではありません。メソッドのドキュメントには適して///いますが、ここでは場違いに見えます。

より良い方法を提案してください。

完璧ではないことはわかってStyleCopいますが、役立つ方法で使用しようとしています。文書化されていない引数について不平を言うという事実が気に入っています。現在、プロパティとコンストラクターについては、テキストがどうあるべきかを推奨していますが、メソッドには役立たず、Disposeそうすべきだと思います。を実装する多くのクラスがありますIDisposable。この特定のケースでは、クラスはWinForm. 問題は、この方法に関する優れたドキュメントを作成できなかったことDisposeです。また、オンラインでも良い例を見たことがありません。多くの例にはコメントがありません。メソッドが第二の性質であると感じている人がDispose、このコメントをどこでも再利用できるように、これを文書化するのを手伝ってくれることを願っています.

これが私たちが持っているものです：

そして、ここに警告メッセージがあります：

他の So ユーザーにも、これに対する回答が役立つことを願っています。ご不明な点がございましたら、お知らせください。

私たちのチームには、styleco ルールを介して適用したいコード ガイドラインがいくつかあります。ほとんどの場合、Settings.Stylecop ファイルが使用されます。ただし、プライベート メソッドのドキュメントを強制したいのですが、設定ファイルでこれを行う方法が見つかりません。プロジェクトを右クリックして「stylecop設定」を選択すると、「ドキュメンテーションルール」の下の「プライベートを無視」のチェックを外すことができ、それで目標を達成できますが、このルールをソリューションとして適用する方法がわかりません。重要なことに、この設定は Settings.Stylecop ファイルに保存されません。

したがって、2 つの質問は次のとおりです。

1. チームと共有できるように、ソリューション ベースでプライベート メソッドのドキュメントを強制する方法は?
2. プロジェクトごとの設定 (設定ファイルをオーバーライドする設定) はどこに保存されますか?

同じクラス (または基本クラス) の他のインスタンス メンバーを参照するインスタンス メンバー内のコードを読むと、混乱する場合があります。

インスタンスメンバーはまだパブリックメンバーを参照できるため、「すべてのプライベート/保護されたメンバーの前に「_」を付ける」などのコーディング標準を持つことは役に立ちません。

これを読む方がはるかに良いでしょう：

コンパイラ オプション、StyleCop、または同様のものを使用して、これを強制する方法はありますか?