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) を生成します。
エージェント モードでのチャット ビュー: プロジェクト ドキュメント ファイルのコレクションを生成します。README.md の作成/更新、UsageExamples.md の作成/更新、ChangeLog.md の作成/更新を行います。 ドキュメント ファイル間のリンク、相互参照クラスとメソッドを含め、ドキュメント間の一貫性を確保します。
Von Bedeutung
エージェント モードでチャット ビューを使用する場合、GitHub Copilot は 1 つのタスクを完了するために複数の Premium 要求を行う場合があります。 Premium 要求は、ユーザーが開始したプロンプトと、Copilot がユーザーに代わって実行するフォローアップ アクションで使用できます。 使用される Premium リクエストの合計数は、タスクの複雑さ、関連するステップの数、選択したモデルによって異なります。
概要
GitHub Copilot は、コードを迅速かつ正確に分析して文書化するのに役立ちます。 チャット ビュー、インライン チャット、クイック チャット、スマート アクション機能は、Visual Studio Code 環境内で直接さまざまなレベルの対話を提供します。