GitHub Copilot を使用して IDE でコード候補を取得する

はじめに

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

このガイドの例では C# を使用していますが、他の言語も同様に機能します。

詳しくは、「IDEでGitHub Copilotによるコード提案」をご覧ください。

前提条件

•           **Copilot** へのアクセス。 GitHub Copilot の GitHub Copilot の Visual Studio を使用するには、Copilot無料 の制限付きアクセス、または有料の Copilot プランのフルアクセスを選択する必要があります。 「[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot)」をご覧ください。
  

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

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

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

コードの提案の取得

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

int CalculateDaysBetweenDates(

int CalculateDaysBetweenDates(

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

コメント内で自然言語を使用してやりたいことを記述することもできます。Copilot は、目的を達成するためのコードを提案します。 たとえば、C# ファイルに次のコメントを入力します。

using System.Xml.Linq;

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

// find all images

using System.Xml.Linq;

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

// find all images

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

代替候補を表示する

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

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

int CalculateDaysBetweenDates(

int CalculateDaysBetweenDates(

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

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

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

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

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

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

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

• C#
• C++

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

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

C++

1. Visual Studio の [Tools] メニューで、[Options] をクリックします。
2. 左側のパネルで、[Text Editor] をクリックします。
3. [ C++]、[ コード スタイル] の順にクリックします。
4. [ コード スタイル ] 見出しの下の [ 全般] をクリックします。
5. [Comments] で、ドロップダウンから [Xml Doc Comments] を選びます。

6.        **既存のコメントスタイルを新しい行の先頭に挿入する** と **1行コメントを続ける** を選びます。 次に、 **[OK]** をクリックします
   

7.        **Options** タブの左側のパネルで、**GitHub** をクリックします。 
   

8. [ Copilot]、[ エディター] の順にクリックします。

9.        **サポートされている言語で自動挿入されたドキュメント コメントに対して、[AI によって生成された説明を有効にする] を選択します**。
   

C#

1. Visual Studio の [Tools] メニューで、[Options] をクリックします。
2. 左側のパネルで、[ 言語] をクリックします。
3. [ C#]、[ その他の設定]、[詳細設定] の順にクリック します。
4. [コメント] の下で、[/// 用の XML ドキュメンテーション コメントを生成]、[// コメントを記述する際に新しい行の先頭に // を挿入]、および [/**/ コメントを記述する際に新しい行の先頭に * を挿入] を選択します。 次に、 [OK] をクリックします

5.        **Options** タブの左側のパネルで、**GitHub** をクリックします。 
   

6. [ Copilot]、[ エディター] の順にクリックします。

7.        **サポートされている言語で自動挿入されたドキュメント コメントに対して、[AI によって生成された説明を有効にする] を選択します**。
   

コメント提案機能を使用する

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

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

次の編集候補

をナビゲートして承認する

行っている編集に基づいて、Copilot により、次に行う可能性のある編集の場所が予測され、その補完が提案されます。

          <kbd>Tab</kbd> キーを使って提案されたコード変更を操作すると、ファイルや参照を手動で検索しなくても、次の関連する編集を簡単に見つけることができます。 提案を受け入れるには、もう一度 <kbd>Tab</kbd> キーを押します。

余白領域にある矢印は、使用できる編集提案を示します。 矢印をクリックして、ショートカット キーを提供する編集候補メニューをaccessします。 編集提案が現在のエディター ビューの外部にある場合、次の提案の位置が上下の矢印で示されます。