インクルードの分析

どのように役立つのですか？

典型的なプロジェクトには、何千もの #include ディレクティブが含まれている可能性があり、調査の価値があるのは明らかではありません。コンパイラのワークロード全体に加算するコード行数に基づいて、各ヘッダーファイルのビルド時間に対するコントリビュートを推定するAnalyzerの試みが含まれます。これは正確なメトリックではありませんが、インクルードされているヘッダーファイルを見つけて優先順位を付けると便利な出発点です。

潜在的に最も大きなインパクトを持つヘッダーの依存関係を特定したら、標準的な方法で1つずつ取り除くことができます。たとえば、次のようにします。

• 可能な限り前方宣言(英語)を使用し

• 不要な #include ディレクティブを削除

• Pimplイディオムを適用

• 大きなヘッダーファイルを小さなヘッダーファイルに分割します。

Includes Analyzerの重要な制限の1つは、分析プロセスを高速化するためにReSharperが実際には完全な前処理段階を実行していないことです。つまり、行数に実際にマクロ展開の結果は含まれず、ガードを含むガードも処理されません。代わりに、ReSharperは各ヘッダファイルがインクルードガードまたは#pragma onceディレクティブで始まり、ソースファイルに最大で1回含まれると仮定します。同じヘッダーを連続してインクルードすると、それが貢献した行の数には数えられません。つまり、内部ツリーノードの隣にあるTimes includedやその他のメトリックがゼロになることがあります。

分析の開始

分析を開始するには、メインメニューからReSharper | インスペクション | include の分析...アクションの1つを呼び出します。または、ソリューションエクスプローラーのコンテキストメニューからIncludesを分析するを選択します。

ReSharperは、指定されたスコープ内のファイルを分析し、ファイル間の依存関係を調べる専用ツールウィンドウにレポートを表示します。include 分析ウィンドウには、2つのビューIncludeesとIncludersがあります。どちらも、各ノードがファイルに対応するツリーとして依存関係を含んでいます。対応するツールバーボタンを使用するか、コンテキストメニューから別のビューの同じファイルに移動して、これらのビューを切り替えることができます。

Includeesビュー

Includeesビューは、トップレベルのツリーノードのヘッダーファイルが直接的または間接的にそれを含むすべてのソースファイルにコントリビュートするコードの行数を理解できます。このビュー内の子ノードは、親ノードからのファイルを含むファイルを表します。Catch2(英語)ソリューション全体の以下の分析を検討してください。

ツリー内の各ノードには3つのメトリックがあります。

• Times includedは、現在のノードへのパスを介して最上位ノードにヘッダーを含むソースファイルの数を示します。上記の例では、catch_common.h は合計75個のソースファイルに含まれていましたが、そのうち26個は catch_tag_alias_autoregistrar.hの #include "catch_common.h" ディレクティブを通じて catch_common.h を含んでいました。

• Line contributionは、最上位ノードのヘッダーが、推移的にインクルードされたファイルなしで、それ自体で現在のノードへのパスを介して貢献したコードの行数を示します。 catch_common.h は合計で4,050行のコードを提供しました。これは75（それを含むソースファイルの数）×54（ファイル内のコードの行数）です。 catch_tag_alias_autoregistrar.hには #include "catch_common.h" が含まれているため、合計4,050本のうち1,404本が提供されます。

• Line contribution inclusiveはLine contributionに似ていますが、このメトリックは、トップレベルノードのファイルに推移的に含まれるすべてのヘッダーを考慮に入れます。たとえば、catch_common.hは、それに含まれるヘッダーとともに、ソリューション全体のコンパイル中に2,654,938行に貢献します。これらの行の1,017,626は、catch_tag_alias_autoregistrar.hの #include "catch_common.h" のために提供されます。Line contribution inclusiveはデフォルトであり、おそらく最も有用なソート基準です。

Includersビュー

IncludersビューはIncludeesビューに似ていますが、逆の方法で動作します。ツリー内の子ノードは、親ノードからファイルに含まれるファイルを表します。

このビューは、スタンドアロンソースファイルとしてコンパイルされたかのように、トップレベルノードのファイルに推移的に含まれるコードの行数を示します（たとえば、catch_common.h とそれに含まれるすべてのヘッダーは、42,365のコード行で構成され、そのうち27,046 #include<string>)で提供されました。このビューが提供するメトリックは次のとおりです。

• インクルードカウント（インクルードファイル数）

• 行数（ファイル自体のサイズ）

• 行数（それに含まれるすべてのヘッダーファイルを含むファイルのサイズ）

オプション

ナビゲーションコントロールとリフレッシュボタンに加えて、Includes分析ウィンドウのツールバーでは、次の2つのオプションを変更できます。

• プロジェクトに属するルートノードのみを表示するは、どのプロジェクトにも属さないファイルに対応する最上位のツリーノードを非表示にします。これは、ソリューション内のヘッダーにのみ集中したい場合に、ライブラリファイルをフィルタする素早い方法です。

• デフォルトでは、解析中にReSharperは空白行とコメントをスキップします。空白行とコメント行をカウントするボタンを使用すると、この動作を変更できます。