【公式ドキュメントを読もうシリーズ】GitHub Copilot の使用についてのベスト プラクティス
シリーズ概要
https://qiita.com/yasu_programming/items/cec66f9e8d5d571e9ce3
URL
https://docs.github.com/ja/copilot/using-github-copilot/best-practices-for-using-github-copilot
説明
Copilot の長所と短所の説明。
下記のことが最適な場合の一部とのこと。
コードの生成しかしたことなかった。
下記を実行できるプロンプト周りも調べよう。
- テストと繰り返しコードの記述
- デバッグと構文の修正
- コードの説明とコメント
- 正規表現の生成
- 専門知識やスキルを更新する。 自分自身が責任者であって、Copilot はサービスの強力なツールであることを忘れないでください。
責任はAIではなく、人間にあるので、チェックはしながら使いたいですね。と今のところ思っていますが、ときが経つと考え方も変わるのかもしれないです(2025年5月4日)。
Copilot コード補完と Copilot Chatの違いの説明。
コード補完の最適な目的
- コード スニペット、変数名、および関数を記述する際の補完
- 繰り返しコードの生成
- 自然言語のインライン コメントからのコード生成
- テスト駆動開発用のテスト生成
テスト駆動開発用のテスト生成をしたことがなかったので、使いたい。便利そう。
Copilot Chat の最適な目的
- コードに関する質問への自然言語での回答
- コードの大きなセクションを生成し、そのコードを反復処理してニーズを満たす
- キーワードとスキルを使用して特定のタスクを実行する。 Copilot Chat には、プロンプトの重要なコンテキストを提供し、一般的なタスクをすばやく実行するように設計されたキーワードとスキルが組み込まれています。 さまざまな種類のキーワードとスキルが、さまざまな Copilot Chat プラットフォームで使用できます。 「IDE で GitHub Copilot に質問する」を参照してください。
- 特定のペルソナとしてタスクを完了する。 たとえば、Copilot Chat に、コードの品質、読みやすさ、効率性について非常に気をつかう C++ のシニア開発者として振舞うように伝え、コードをレビューするように依頼できます。
特定のペルソナとしてタスクを完了するとあるが、こういうプロンプトって言葉遊びみたいって正直思ってしまったが、公式で書いているんだし、違いってあるんだろうなあ。どこかで比較したい。
適切なプロンプトエンジニアリングの概要の説明。
- 複雑なタスクを分割する。
- 要件について具体化する。
- 入力データ、出力、実装などの例を提供する。
- 適切なコーディング プラクティスに従う。
抽象的ではなく、具体的なタスクを渡すことで、より価値のある応答をしてくれるんだね。
例を提供するの意識したい。
細かいところはCopilot Chat のプロンプト エンジニアリングに書かれているが、追々見ていきます。
使用時の注意点。
使用時のヒント。
- Copilot に役立つコンテキストを次のように指定します。
- IDE で Copilot を使用している場合は、関連するファイルを開き、無関係なファイルを閉じます。
そうなんだ。影響しちゃうんだね。意識しないと忘れそうだけど、使わないファイルは閉じよう。
所感
Tipsだけ読んでても気づかないことが多いので、公式ドキュメント読むの発見多いなと思った。