メソッドのタグの存在をアサートする

ここにサマリータグが存在することを宣言できますか？私の方法についてメソッドのタグの存在をアサートする

/// <summary> this is my summary </summary> 
public void myMethod() 
{ 
    // dostuff 
}

マイドキュメントは要約/カテゴリ/ PARAMようなタグに依存している、と私はすべてのメソッドは、指定されたタグを持っていることを確認したいと思いますか？

あなたはRosylnコードアナライザでそれを行うことができます。 – Blorgbeard

作成後の手順を実行して、生成されたXMLをXSDスキーマに対して検証することもできます。 – Steve

@Steve coolリソースに私を指摘できますか？ –

コードアナライザは、このような状況のために作成されました。単体テストを使用してコードに正しいコメントがあることを検証する代わりに、ビルド中にエラーを生成することができます。

このケースでは、これを行うための既存のスタイルコップアナライザがあります。 SA1600 ElementsMustBeDocumentedとSA1604 ElementDocumentationMustHaveSummaryはあなたの望むものとまったく同じです。

StyleCop analyzersをソリューション/プロジェクトに追加し、SA1600とSA1604をエラーに設定すると、ドキュメントが提供されるまでコードが構築されなくなります。

あなたのニーズに合わない場合は、ユースケースをカバーする独自のアナライザーを作成することができます。

2017-01-06 03:26:35

どの要素を文書化する必要があるのですか？ –

あなたはしません。私が提供したルールは、ドキュメンテーションが存在し、要約タグが存在するという事実をカバーします。さらなるルールが必要な場合は、 'SA16XX'の範囲内の他のルールを見たり、それらのルールがあなたのニーズに合わない場合は独自のアナライザを作成したりすることができます。 –

私はそれが要約タグとカテゴリタグの両方を持つことを望みます –

答えて