GitHub Copilotにコードを提案してもらう方法 ～Pythonを例に詳しく解説

使い方① コメントに続くコードを提案してもらう

　 コメント（コードの説明文）を書いて、GitHub Copilotに、続くコードを提案させます。 なおPythonでは#記号から行末までがコメントとなります。

　実際に試していきましょう。まず、VS Codeで、新しいファイルを作成します（［Ctrl］＋［N］キー）。そして、新しいファイルのエディター内の［言語の選択］をクリックして、［Python］を選びます（またはファイルを「～.py」という名前で保存します）。これにより、このエディターではPythonのコードが提案されるはずです。なおショートカットキーについては以降、Macの場合は［Ctrl］キーは［command］キーに読み替えてください。

VS Code上で［Ctrl］＋［N］キーを押す（❶）と新しいファイルが作成される。［言語の選択］をクリック（❷）

［Python］をクリック（❸）

　またコード提案を試していくにあたり、 VS Code画面下部の［Copilot］アイコンをクリックし、Pythonの［コード補完（コード提案：Inline Suggestions）］にチェックが入れてあることを確認 してください。そして、作成したファイルに以下のようにコメントを入力します。コメントを最後まで入力したら［Enter］キーを押して改行します。

# 1 から10までの合計を計算して変数に代入

Pythonのコメントを入力（❹）。［Enter］キーを押して改行

　すると、GitHub Copilotのコード提案が表示されます。 提案されたコードは、［Tab］キーを押して受け入れ（確定） できます。または、 ［Esc］キーを押すとキャンセル できます。

コード提案が表示される。［Tab］キーを押すと受け入れ、［Esc］キーを押すとキャンセルできる

　なお、繰り返しますが、 提案されるコードは、本書の例とはまったく同じにはならない可能性があります。 たとえば、変数名は、本書の例、あるいは読者が期待したものとは異なるものが提案されるかもしれません。その場合は以下のいずれかを試してください。

• 「# 1から10までの合計を計算して変数totalに代入」のように、コメント内で変数名を明記する
• 一度［Tab］キーを押して提案を確定してから、変数名を手動で修正する
• 「total =」のように変数名までを手動で入力し、その続きを提案させる

　また、ここでは［言語の選択］でPythonを選んでいるため（またはファイルを「～.py」として保存しているため）、このエディターではPythonのコードが提案されるはずです。 もし他のプログラミング言語で提案されてしまう場合は「# 1から10までの合計を計算して変数に代入するPythonコード」といったようにコメントで明示的に言語を指定できます。 ただし、通常はそこまでする必要はないはずです。

使い方② コードを書いてその続きのコードを提案してもらう

　もし、「変数を使わずに、1から10までの合計を求め、printで表示したい」という場合はどうすればよいでしょうか。もちろん、先ほど説明したように、それをコメントとして書けばよいです。すると、コメントに沿って適切なコードが提案されるでしょう。

# 変数を使わずに、1から10までの合計を求め、printで表示

コメントを入力（❶）。［Enter］キーを押す（❷）。記述されたコメントからコードが提案される

　一方、 コードの書き出し部分を少し入力して、その続きをGitHub Copilotに提案させる という方法もあります。たとえば、以下のように、コメントを入力します。

# 1 から10までの合計を求める

　すると、GitHub Copilotが、その続きを予測し、コードを提案してくれます。

コメントを入力（❸）。［Enter］キーを押す（❹）。コードが提案される

　ここでは、変数totalを0で初期化する、というコードが提案されています。しかし、この提案は今回は使用しないので、無視して（あるいは［Esc］キーを押して提案を消して）、printと入力します。

# 1 から10までの合計を求める
print

　すると、GitHub Copilotが、printに続くコードを予測して提案してくれます。Tabキーを押すと、提案を確定できます。

「print」を入力（❺）。「print」の続きを正しく予測して提案してくれる。［Tab］キーを押す（❻）

　このように、GitHub Copilotによって、開発者が期待したコードが常に1回で提案されるわけではありませんが、それはおそらくヒントが少なすぎるからです。 ヒントとしてコードの先頭部分を少し入れてあげたり、コメントを少し詳しく書いてあげたりすると、提案がより適切なものとなります。