GitHub Copilotの "説明" 機能と "ドキュメント" 機能を確認する
GitHub Copilotを使用すると、開発者は複雑なコードやなじみのないコードを簡単に操作できます。 Visual Studio Codeでは、開発者はコードの分析、説明、ドキュメント化を行うGitHub Copilot機能に直接アクセスできます。
GitHub Copilotを使用してコードを分析して説明する
コードの分析と説明には、次のGitHub Copilot機能を使用できます。
質問モード: 質問モードでチャット ビューを使用して、ワークスペース全体を分析し、コーディングトピック、テクノロジの概念、および一般的なプログラミングプラクティスについて質問します。
インライン チャット: エディターから直接インライン チャット セッションを開始して、特定のコード セクションについて質問します。
スマート アクション: Explain スマート アクションを実行して、選択したコードを説明します。プロンプトを記述する必要もありません。
クイック チャット: 簡単な質問をして、作業内容に戻ります。
GitHub Copilotを使用してインライン コードドキュメントを生成する
次のGitHub Copilot機能を使用して、インライン コード ドキュメントを生成できます。
Ask モード: Ask エージェント モードを使用して、コード ファイル、クラス、またはメソッドのインライン コード ドキュメントを提案します。 チャット ビューで、推奨されるインライン ドキュメントを確認します。 チャット会話で必要に応じて更新を要求します。 提案されたドキュメントに問題がなければ、提案されたドキュメントを対応するコード ファイルに挿入できます。
プラン モード: 計画モードを使用して、ドキュメント タスクの詳細な実装計画を作成します。 プラン モードを使用すると、コードベースの分析、ドキュメントの要件の特定、ステップ バイ ステッププランの作成を行うことができます。 プランが承認されたら、実行のためにエージェント モードに引き渡すことができます。
エージェント モード: エージェント モードを使用して、指定されたコード プロジェクト、ファイル、クラス、またはメソッドのインライン コード ドキュメントを自律的に生成します。 エージェントに、ドキュメント プロセスの実行中または後に他のタスクを実行させます。 エージェントが割り当てられたタスクを完了したら、更新を受け入れるか拒否します。
インライン チャット - インライン チャット セッションを使用して、コード エディターで直接作業します。 インライン チャットは、エディターを終了せずに特定のコード (クラス、メソッド、またはコード ブロック) を文書化する場合に便利です。 必要に応じて、プロンプトで特定の手順を指定するか、特定の情報を指定せずに
/docスラッシュ コマンドを使用できます。 更新プログラムはコード エディターに表示され、承認または拒否できます。 更新プログラムの有無にかかわらず、プロンプトを再実行するオプションを選択することもできます。ドキュメント スマート アクションの生成: [ドキュメントの生成] スマート アクションを使用して、選択したクラス、メソッド、またはコード ブロックのインライン コード ドキュメントを生成します。 [ドキュメントの生成] スマート アクションは、プロンプトを必要とする特定の要件がない場合に便利です。 更新プログラムはコード エディターに表示され、承認または拒否できます。 スマート アクションを再実行することもできます。
GitHub Copilotを使用してプロジェクト ドキュメントを生成する
次のGitHub Copilot機能を使用して、プロジェクト ドキュメントを生成できます。
Ask エージェント モードのチャット ビュー: Ask エージェントを使用してコードベースを分析し、コード プロジェクト、ファイル、およびクラスについて理解を深めます。 Ask エージェントを使用して、推奨されるプロジェクト ドキュメントをプレビューできます。 必要に応じて、提案を確認し、更新プログラムまたはその他の詳細を要求します。 提案されたドキュメントをプロジェクト ドキュメント ファイル (README.md) に挿入します。
プラン エージェント モードのチャット ビュー: プロジェクト ドキュメントの詳細な実装計画を作成し、実行のためにエージェント モードに引き渡します。
エージェント モードでのチャット ビュー: プロジェクト ドキュメント ファイルのコレクションを生成します。README.md の作成/更新、UsageExamples.md の作成/更新、ChangeLog.md の作成/更新を行います。 ドキュメント ファイル間のリンク、相互参照クラスとメソッドを含め、ドキュメント間の一貫性を確保します。
Von Bedeutung
エージェント モードでチャット ビューを使用すると、入力した各プロンプトは 1 つの Premium 要求としてカウントされ、モデルの乗数が乗算されます。 GitHub Copilotタスクを完了するためにいくつかのフォローアップ アクションが実行される場合がありますが、これらのフォローアップ アクションは Premium 要求の使用量にはカウントされません。 入力したプロンプトのみが課金されます。 使用される Premium 要求の合計数は、入力するプロンプトの数と選択したモデルによって異なります。 GitHub Copilotの無料プランでは、1 か月あたり 50 個の Premium 要求を受け取ります。 各GitHub Copilot サブスクリプションの Premium 要求制限の詳細については、プランの説明を確認してください。
概要
GitHub Copilotは、コードを迅速かつ正確に分析して文書化するのに役立ちます。 チャット ビュー、インライン チャット、クイック チャット、スマート アクション機能は、Visual Studio Code環境内で直接さまざまなレベルの対話を提供します。