Skip to main content

GitHub Copilot を使用して IDE でコードの提案を取得する

GitHub Copilot を使用して、エディターでコードの提案を取得します。

Visual Studio と GitHub Copilot について

このガイドでは、Window 用の Visual Studio で GitHub Copilot からコーディングの提案を取得する方法について説明します。 その他の一般的なコーディング環境の説明を確認するには、ページの上部にあるツール スイッチャーを使います。

このガイドの例では C# を使用していますが、他の言語も同様に機能します。 GitHub Copilot は、多数の言語とさまざまなフレームワークに対する候補を提示しますが、特に Python、JavaScript、TypeScript、Ruby、Go、C#、C++ に適しています。 GitHub Copilot は、データベースのクエリ生成や、API とフレームワークの候補の生成にも役立ちますし、コード開発としてインフラストラクチャを構築することもできます。

前提条件

  • Copilot へのアクセス権。 Visual Studio で GitHub Copilot を使用するには、アクティブな Copilot サブスクリプション (Copilot Pro、Copilot Enterprise、Copilot Business など) または Copilot Free を介したアクセスが必要です。これにより、機能が制限されます。 Copilot のアクセス方法の詳細については、「GitHub Copilot とは何ですか?」を参照してください。

  • 互換性のあるバージョンの Visual Studio です。 Visual Studio で GitHub Copilot を使うには、Windows 用の Visual Studio 2022 17.8 以降がインストールされている必要があります。 詳細については、Microsoft ドキュメントの「Visual Studio のインストール」を参照してください。

  • Visual Studio Code の GitHub Copilot 拡張機能。 Copilot 拡張機能をインストールする方法については、Microsoft ドキュメントの「Visual Studio で GitHub Copilot をインストールする」を参照してください。

  • GitHub アカウントを Visual Studio に追加します。 Microsoft ドキュメントの「Visual Studio のキーチェーンに GitHub アカウントを追加する」を参照してください。

コードの提案の取得

GitHub Copilot では、入力時にコーディングの提案が提供されます。 たとえば、次の関数シグネチャを C# ファイルに入力します。

C#
int CalculateDaysBetweenDates(

GitHub Copilot による関数本体全体の候補が自動的に灰色のテキストで表示されます。 候補を受け入れるには、Tab キーを押します。

コメント内で自然言語を使用して実行する操作を記述できます。Copilot では、目標を達成するためのコードが提案されます。 たとえば、C# ファイルに次のコメントを入力します。

C#
using System.Xml.Linq;

var doc = XDocument.Load("index.xhml");

// find all images

GitHub Copilot による関数の実装の候補が表示されます。 候補を受け入れるには、Tab キーを押します。

Tip

Copilot から受け取る提案数が少ない場合、または提案がまったくない場合、重複検出を有効にしている可能性があります。 重複検出の詳細については、「個人のサブスクライバーとしての Copilot ポリシーの管理」を参照してください。

代替候補を表示する

特定の入力に対して、GitHub Copilot が複数の候補を提示することがあります。 使う候補を選択するか、すべての候補を拒否できます。

たとえば、次の関数シグネチャを C# ファイルに入力します。

C#
int CalculateDaysBetweenDates(

GitHub Copilot による候補が表示されます。

次に、候補の上にマウス ポインターを置くと、候補を選べるように GitHub Copilot コントロールが表示されます。 次または前の候補を表示するには、コントロールの前方矢印または戻る矢印ボタンをクリックします。

または、Alt+ キーを押して代替候補を表示することもできます。 (または Alt+,) キーを押します。

提案を受け入れるには、Copilot コマンド パレットで [承諾する] をクリックするか、Tab キーを押します。すべての提案を拒否するには、Esc キーを押します。

コメントの提案を取得する

Note

  • 現在、コメントの提案はパブリック プレビューであり、変更される可能性があります。
  • コメントの提案は、Visual Studio 17.14 プレビュー 2 以降で使用できます。

GitHub Copilot は、作成したコードを分析し、コードの動作を説明するコメントを生成することで、コードに対するコメントを提案できます。 Copilot Free ユーザーの場合、コメントの提案は、コードの提案の使用量ではなく、毎月の Copilot Chat の使用量にカウントされます。

コメントの提案は次の言語で使用できます。

  • C#
  • C++

コメントの提案を有効にする

コメントの提案を有効にするには、Visual Studio でコメント スタイルを構成する必要があります。

C++ の場合

  1. Visual Studio の [Tools] メニューで、[Options] をクリックします。
  2. 左側のパネルで、[Text Editor] をクリックします。
  3. [C++][Code Style][General] の順にクリックします。
  4. [Comments] で、ドロップダウンから [Xml Doc Comments] を選びます。
  5. [Insert existing comment style at the start of new lines when writing comments][Continue single line comments] を選びます。

C# の場合

  1. Visual Studio の [Tools] メニューで、[Options] をクリックします。
  2. 左側のパネルで、[Text Editor] をクリックします。
  3. [C#][Advanced] の順にクリックします。
  4. [Comments] で、[Generate XML documentation comments for ///][Insert // at the start of new lines when writing // comments][Insert * at the start of new lines when writing /* */ comments] を選びます。

コメントの提案を使う

コメントの提案を開始するには、コメントするコードの前に、作成している言語の標準のコメント開始文字 (たとえば、///) を入力し、提案が表示されるまで待ちます。

候補を受け入れるには、Tab キーを押します。提案を変更するには、Alt+/ キーを押します。 提案を拒否するには、Esc キーを押します。

次のステップ

  • 有効なプロンプトを記述する方法 - 「Copilot Chat のプロンプト エンジニアリング」を参照してください。
  • エディターで Copilot を構成する - エディター内から GitHub Copilot を有効または無効にしたり、Copilot 用に独自の優先キーボード ショートカットを作成したりできます。 「環境での GitHub Copilot の構成」を参照してください。
  • GitHub Copilot Chat の概要 - GitHub Copilot Chat を使用して、Copilot に情報と支援を依頼する方法について説明します。 「IDE で GitHub Copilot に質問する」を参照してください。
  • 問題 のトラブルシューティング - GitHub Copilot に関する一般的な問題のトラブルシューティング方法の詳細を確認します。 「GitHub Copilot のトラブルシューティング」を参照してください。