GitHub、Copilotでより高い精度のコードを生成させる方法を指南。関連ファイルを開く、トップレベルのコメントを書くなど

今回は「GitHub、Copilotでより高い精度のコードを生成させる方法を指南。関連ファイルを開く、トップレベルのコメントを書くなど」についてご紹介します。

関連ワード （作成、文字列、補完等） についても参考にしながら、ぜひ本記事について議論していってくださいね。

本記事は、Publickey様で掲載されている内容を参考にしておりますので、より詳しく内容を知りたい方は、ページ下の元記事リンクより参照ください。

GitHubは、AIがコードの生成を支援してくれるGitHub Copilotを使いこなすテクニックを示した記事「How to use GitHub Copilot in your IDE: Tips, tricks, and best practices」を公開しました。

記事の中で、プログラマが意図したコードを高い精度で生成AIに生成させるためのテクニックがいくつも紹介されています。これらのテクニックはCopilotに限らず、生成AIを用いてコードを生成させる際の参考になると思われます。

この記事では、紹介されているテクニックのポイントをまとめてみました。

GitHub Copilotでよりよいコードを生成するためのポイント

生成AI活用の基本として説明されたのは、大規模言語モデルを用いた生成AIでは、コンテキスト（文脈）に基づいて予測を行うように設計されているため、生成AIに対する入力やプロンプトがコンテキストに富んでいるほど良い出力が得られる、という原則です。

それゆえ、GitHub CopilotおよびGitHub Copilot Chatを利用する際には、いかに多くのコンテキストをそれらに伝えるかが重要になるわけです。

Open your relevant files（関連するファイルを開いておく）

GitHub Copilotはエディタで現在開いているファイルを見てコンテキストを分析するため、関連するファイルは開いておきましょう。また、不必要なファイルは閉じておきましょう。

Provide a top-level comment（トップレベルのコメントを書く）

作業中のファイルにトップレベルのコメントを書いておくと、GitHub Copilotが全体的な背景を理解しやすくなります。特にデータを処理したり文字列を操作したりする場合は、操作の例があるとかなり役立ちます。

Set Includes and references（インクルードや参照を設定しておく）

作業に必要なinclude/importsやモジュール参照、特に特定のバージョンのパッケージを扱う場合にはそれらをあらかじめ設定しておくことで、GitHub Copilotがサジェストを作成する際に役立ちます。

Meaningful names matter（意味のある命名は重要）

関数にfooやbarという名前をつけると、GitHub Copilot は名前から意図を推測できないため最適な補完を行うことができません。

Provide specific and well- scoped function comments（具体的かつ適切なスコープの関数のコメントを書く）

関数名はその関数の十分な説明にならないため、関数のコメントはGitHub Copilotが知る必要のある詳細な情報取得に役立ちます。またコード中の具体的で短いコメントは、GitHub Copilotがより正確にコンテキストを理解するのに役立ちます。

Provide sample code（サンプルコードを示す）

GitHub Copilotにサンプルコードを提供することで、あなたが何を求めているかを判断するのに役立ちます。また、現在のコーディング標準やプラクティスに基づいた提案を返すのにも役立ちます。ユニットテストは、個々の関数/メソッドレベルでのサンプルコードを提供できる手段です。

元記事では上記の詳細についてや、GitHub Copilot Chatを活用するためのテクニックなども紹介されています。