VisualStudioCodeのGitHubCopilotのドキュメントを読む その１２（プロンプトのコツ）

開いているファイル

コード補完の場合、Copilotはエディタで現在のファイルと開いているファイルを調べて、コンテキストを分析して適切な提案を作成します。
Copilotの使用中に関連ファイルをVS Codeで開いておくと、このコンテキストを利用してCopilotはプロジェクトの全体像を把握できます。

トップレベルのコメント

作業中のファイルの最上位のコメントはCopilotが作成している全体的なコンテキストを理解するのに役立ちます。

適切なインクルードと参照

作業に必要なインクルードまたはモジュール参照は手動で設定することをお勧めします。
どのような依存関係をインクルードする必要があるかはユーザが一番よく知っているはずです。
これは提案を作成する際に使用するフレームワーク、ライブラリ、およびそれらのバージョンをCopilotに知らせるのにも役立ちます。

次のTypeScriptの例ではaddメソッドの出力をログに記録します。
参照を設定していない場合、Copilotはconsole.logの使用を提案します。

class Calc {
    add(a: number, b: number): number {
        // log the result of the addition
        console.Log('result:', a + b); // <-このような提案が行われれる

        return a + b;
    }
}

一方、Log4jsへの参照を追加すると、Copilotは出力のロギングにそのフレームワークを使用することを提案します。

import * as log4js from 'log4js';

class Calc {
    add(a: number, b: number): number {
        // log the result of the addition
        Log4js.getLogger().info('result:' + (a + b)); // <-このような提案が行われれる

        return a + b;
    }
}

意味のある関数名

fetchData()というメソッド名があまり意味がないように、Copilotの役にも立ちません。
意味のある関数名を使用することでCopilotはあなたが望むことを提供することができます。

具体的でスコープの広い関数コメント

関数名は過度に長くならないように説明的である必要があります。
関数のコメントはCopilotが知る必要がある詳細を入力するのに役立ちます。

Prime Copilotとサンプルコード

Copilotを正しい結果に導く1つのコツは探しているものに近いサンプルコードをコピーして開いているエディタに貼り付けることです。
小さな例を提供することでCopilotが達成したい言語とタスクに一致する候補を生成するのに役立ちます。

Copilotが実際に使用するコードを提供し始めたらファイルからサンプルコードを削除できます。
これはデフォルトで古いコード候補が表示される場合にCopilotを新しいバージョンのライブラリにジャンプスタートさせるのに特に役立ちます。