1

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

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

    /// <summary>
    /// Clean up any resources being used.
    /// </summary>
    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            if (this.components != null)
            {
                this.components.Dispose();
            }
        }

        base.Dispose(disposing);
    }

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

Warning 15 SA1611: The documentation header must contain param tags matching the element's parameter list.

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

4

3 に答える 3

2

ここにはいくつかの良いコメントがありますが、StyleCop に準拠するまでには至っていません。必要なものはこれです：

/// <summary>
/// Releases the unmanaged resources used by this
/// class and optionally releases the managed resources.
/// </summary>
/// <param name="disposing">True to release both managed and unmanaged
/// resources; false to release only unmanaged resources.</param>

お役に立てれば！

于 2010-08-06T16:09:51.810 に答える
2

これは、プロジェクト テンプレートから自動生成されたコードです。唯一の本当の修正は、テンプレートを変更するか、Designer.cs ソース コード ファイルを編集することです。テンプレートは Common7\IDE\ItemsTemplate(Cache)\CSharp\Windows Forms\xxxx\Form.zip\form.designer.cs にあります。もちろん、それを編集しても、将来のプロジェクトの問題のみが修正されます。

通常、自動生成されたコードを編集することは最善のアイデアではありませんが、この特定のケースでは問題なく実行できます。

于 2010-08-06T15:58:36.620 に答える
1

GhostDoc を使用して調査できます。多くの場合、継承ツリーを検索し、親クラスからコメントを見つけます。この場合、Dispose メソッドがオーバーライドされるため、意味のあるコメントが見つかります。

于 2010-08-10T10:15:17.987 に答える