VS2010ソリューションで文書化されていないコードメンバーを見つける

Question

単純なツールやVisual Studioのマクロを知っている人は、プロジェクトやソリューションのコードメンバーを見つけてリストする（またはマクロの場合は理想的にナビゲートする）それらに関連付けられたXMLドキュメントはありませんか？

この背景には、すべてのメンバーがドキュメンテーションを必要とすることを除けば、各メンバーは変更履歴と変更管理番号を持つコードヘッダーを持つ必要があります。これらのコードヘッダーはXMLコメント表記も使用しており、ドキュメントよりもはるかに重要です。現在の開発段階で膨大な量の新しいコードを追加したので、必要なドキュメントとコードヘッダーを適用するために、文書化されていないすべてのメソッドを見つける方が簡単です。

これは更新されたコードには役立ちませんが、少なくとも新しいクラスとメンバーにとっては助けになります。アドバイスをいただければ幸いです。コードベースはかなり大きく、この作業をより簡単にすることができるものはプラスです。

プロジェクトをコンパイルするとき、Visual Studioは文書化されていないメンバーに警告することができますが、公開されているメンバーのみを拾っているようです - プライベートまたは内部のものは欠落しています。

ありがとうございます。
リチャードモス

Answer 1

静的解析タスクのような音がします。 FxCopは1つのオプションです（新しいバージョンのVisual Studioに含まれているか、別のダウンロードとして入手できます）。

編集： StyleCop氏ラモスによって示唆されているように、より良い選択かもしれませんので、FxCop rules listを見て、私は、「XML」や「コメント」のルールが表示されません。

カスタムルール（see here for StyleCop）を作成する必要が生じることがあります。この場合、静的解析ツールは動作するはずです。

Using FxCop for XML comment enforcement

Answer 2

（すでに述べたように）FxCopのかStyleCopは、あなたが不足しているドキュメントを見つけましょう。

私のアドイン、AtomineerUtilsは不足しているドキュメントをすばやく記入し、すべてのドキュメントが必要なスタイルに従うようにするのに役立ちます。

• それはそれは方法、返品、パラメータ、例外などを文書化することにより、独自のドキュメントのための良い出発点を提供し、メンバーにドキュメンテーションコメントを追加することができます
• コードファイルに標準のファイルヘッダーを追加することができます
• 既存のコメントを更新して、特定のスタイルに従っているかどうかを確認したり、内容を整理して内容を整理したり、コメントがコードと同期しているかどうかを確認できます（すべてのパラメータは正しく文書化されています）。
• 指定されたスコープ内のすべてのメンバー（名前空間/クラス/インターフェース/構造体など）を1回のパスで処理して、短時間でソースファイル全体をidyします。
• C＃、C++、C++/CLI、C、Visual Basic、Javaをサポートしています。

標準に準拠していないファイルが見つかると、時間が大幅に節約できます。