2016-12-21 10 views
0

GhostDoc、StyleCop、CodeIt.Right、FXCopなどを試して、自動生成されたXMLコメントをC#コードに追加し、既存のコメントをケースパラメータで更新する方法を探しています例えば変更されました。XMLドキュメントの不足に関するレポートを入手できますか

GhostDoc Proは、カバレッジに関するレポートを取得できないか、または少なくともドキュメントが完全にないクラスを除いて、うまく機能しているようです。

このようなレポートはどのように入手できますか?

+1

クラス、メソッド、またはパラメータ名から自動生成できれば意味がないことに気づいたときに、自動生成されたコメントの使用を停止しました。しかし、XMLコメント生成を有効にすると、パブリックメソッド、クラス、およびXMLドキュメントを持たないプロパティ。 –

+0

はい、私は "CS1591警告:公開されているタイプまたはメンバのXMLコメントが見付かりません"というメッセージが表示されますが、ビルドの出力からこれらの警告のみを抽出する方法はわかりません。 –

答えて

1

上記のように、GhostDocはこれを手助けします。より新しいバージョンまたは適切なエディションが必要な場合があります。

v5のGhostDoc Proドキュメンテーション保守機能を使用すると、自動生成されたドキュメントの検索、ドキュメントが見つからないクラス/メソッドの検索、および更新が必要なメソッドやメソッドの同期化が容易になります。または編集する。ここでは、v5の機能の詳細です - http://submain.com/blog/ReleasedGhostDocV50.aspx

あなたはまた、CodeIt.Rightを使用すると言いました - ルールGE00005をオンにしたい - 外部から見えるタイプとメンバにはXMLコメントが必要です(タイプ、メンバ - > XMLコメントが必要です)。 VSでリストをエクスポートすることも、ビルドでリストを生成することもできます。

GhostDocとCodeIt.Rightの両方で、欠落しているドキュメントのXMLコメントテンプレートが生成されますが、後でそれらを編集する必要があります。

関連する問題