すでにメンバーの場合は

無料会員登録

GitHubアカウントで登録 Pikawakaが許可なくTwitterやFacebookに投稿することはありません。

登録がまだの方はこちらから

Pikawakaにログイン

GitHubアカウントでログイン Pikawakaが許可なくTwitterやFacebookに投稿することはありません。

コードの解説をしてもらおう

この記事で出来るようになること

コードの解説をしてもらおう

ここまで全てのコードをGitHub Copilotによって作成してもらいました。そのため、部分的に理解できないコードがあるかもしれません。このように第三者が書いたコードを効率よく理解することができるコマンドがGitHub Copilotには用意されています。それが/explainコマンドです。

インラインチャットを使用したコード解説

この章ではインラインチャットで/explainコマンドを使ったコードの解説方法を学びます。復習すると、インラインチャットというのはエディタ内でチャットウィンドウを開いて質問する機能です。

インラインチャットを使ってコードの解説をしてもらおう

それでは、インラインチャット使って「/explain」コマンドを使い、コードの解説をしてもらいましょう。

commandキーを押しながらiキーを押すとインラインチャットが表示されるので、「/explain」と入力します。開く場所はどこでも構いません。すると以下のように、このファイルで定義されている関数や定数などの一覧が表示されます。この中から説明してほしいものを選択するとCopilotが該当コードの解説をしてくれます。

インラインチャットでの解説

上の動画のような回答が返ってくるか確認しましょう。

ハイライト機能を使用したコード解説

コードハイライト機能を使いコードの解説をしてもらおう

選択肢から特定の部分のコードを選んで解説してもらう以外にも、自分でコードを指定して解説をしてもらうことができます。やり方は、その部分をハイライトした状態でインラインチャットで質問をするだけです。

ハイライト機能

するとハイライトしたコードのみを参照し、コードの解説をしてもらえます。

ハイライト機能

もちろんインラインチャットではなく、通常のチャットでも同じように解説してもらうことができます。

通常のチャット

上の画像のような回答が返ってくるか確認しましょう。

会話の履歴を活用しよう

過去に入力したプロンプトは記録されているため、参照することが可能です。

過去のプロンプトを呼び出そう

今回/explainというコマンドを2回実行しました。
このように前回入力したコマンドを再度実行する場合は、会話の履歴を活用すると便利です。チャット欄ではターミナルのように上下の矢印キーを使うことで、過去のプロンプトを呼び出すことができます。
こちらも便利な機能なので覚えておきましょう。

履歴の活用

上の画像のように過去のプロンプトが呼び出せるか確認しましょう。

この記事のまとめ

  • /explainコマンドを使うとコードの解説をしてもらうことができます。
  • インラインチャットで使用すると説明したいコードを選択することができます。
  • 説明したいコードはハイライトした状態で/explainコマンドを実行します。