Visual Studio の C++ Include 診断

Visual Studio 17.8 以降、Visual Studio は C++ #include ファイルの分析に役立ちます。

• 各ヘッダー ファイルの何かが使用される頻度と場所を表示します。
• 各 #include ファイルのビルド時間を表示します。これは、ビルド時間を最適化する機会を特定するのに役立ちます。

C++ インクルード診断と CodeLens を有効にする

C++ インクルード診断機能は、既定ではオフになっています。 有効にするには、コード エディターで右クリックしてコンテキスト メニューを表示し、 Include ディレクティブを選択します>[診断 #include をオンにします。

#include ファイルに関する情報は CodeLens を介して表示され、既定ではオフになっています。 関連する CodeLens 設定を有効にするには、 Tools>Options>Text Editor>All Languages>CodeLens に移動し、 Show C++ #include 参照 と Show C++ のコンパイル時間の両方が有効になっていることを確認します 。

#include参照を表示する

[診断を含める] を試すには、新しい C++ コンソール プロジェクトを作成します。 メインの .cpp ファイルの内容を次のコードに置き換えます。

#include <iostream>
#include <vector>

// a function that takes a vector of integers and prints them out
void print(std::vector<int> &vec)
{
    for (int i : vec)
    {
        std::cout << i << std::endl;
    }
    std::cout << std::endl;
}

// a function that takes a vector of integers and adds 10 to each element of the vector and store the result in a new vector
std::vector<int> add10(std::vector<int>& vec)
{
    std::vector<int> newVec;
    for (int i : vec)
    {
        newVec.push_back(i + 10);
    }
    return newVec;
}

int main()
{
    std::vector<int> vec = { 7, 5, 16, 8 };

    print(vec);
    auto newVec = add10(vec);
    print(newVec); 
}

C++ インクルード診断を有効にすると、ヘッダー ファイルの上に現在のコード ファイル内のヘッダー ファイルのコードが参照される回数が表示されます。 前のコード サンプルでは次のようになります。

6 references
#include <iostream>
5 references
#include <vector>

コード エディターで、上記#include <vector>5 つの参照を選択し、このファイルで<vector>コードが使用されている場所の概要が表示されます。

コード内の場所に移動する項目を選択します。

ビルド時間 #include 表示する

#includeした各ファイルのビルド時間を確認するには、まず Build Insights を使用してビルドします。

Build>Run Build Insights on Solution>Build を選択して、メイン メニュー バーから Build Insights を有効にします。 ビルドが完了すると、コンパイルされるさまざまなファイルのビルド時間を一覧表示するウィンドウが表示されます。 ソース コード ウィンドウに戻り、各 #include ファイルのビルド時間が CodeLens に表示されます。 次のようになります。

6 references | Build: 0.3560s
#include <iostream>
5 references | Build 0.0360s
#include <vector>

使用頻度の低いもののコンパイル時間に大きな影響を与える #include ディレクティブがある場合は、このツールを使用して特定できます。

この記事では、C++ インクルード診断と CodeLens を有効にする方法と、C++ インクルード診断を使用してインクルード ファイルの何かが使用される頻度と、 #include がビルド時間に与える影響を分析する方法について説明しました。

関連項目

C/C++ インクルード クリーンアップの概要
インクルード クリーンアップのメッセージ