GitHub Copilot を使用してインライン コードドキュメントを生成する

  • 9 分

コードを適切に文書化すると、読みやすく保守しやすいコードベースが作成され、他の開発者が理解して操作しやすくなります。

GitHub Copilot Chat は、コードを迅速、正確、一貫して文書化するのに役立ちます。

次の GitHub Copilot の各機能を使用して、インライン コード ドキュメントを作成できます。

  • チャット ビュー: チャット ビューは、Ask、Edit、Agent モードで使用できます。
  • インライン チャット: エディターを終了せずに、インライン チャット セッションを使用して特定のコード (クラス、メソッド、またはコード ブロック) を文書化します。
  • スマート アクション: [ドキュメントの生成] スマート アクションを実行して、プロンプトを記述しなくても、選択したコードについて説明します。

チャット ビューを使用してインライン コード ドキュメントを生成する

チャット ビューを使用すると、プロジェクト、コード ファイル、クラス、またはメソッドのインライン コード ドキュメントを生成できます。 コード ファイルを更新する前に、推奨されるドキュメントを確認し、必要に応じて更新を要求できます。

チャット ビューの 3 つの各モード (Ask、Edit、Agent) を使用して、インライン コード ドキュメントを生成できます。 エージェント モードを使用するコストは、他のモードよりも高くなります。これは考慮に入れる可能性があります。

Ask モードのチャット ビューを使用してインライン コード ドキュメントを生成する

Ask モードを使用すると、コードを評価し、プロジェクト、クラス、またはメソッドのインライン コード ドキュメントを提案できます。 コード ファイルにドキュメントを追加する前に、推奨されるインライン ドキュメントを確認し、必要に応じて更新プログラムを生成できます。

  1. チャット ビューを Ask モードで開きます。

  2. チャット プロンプトにコンテキストを追加します。 たとえば、ドキュメント ガイドラインを提供するマークダウン ファイルを追加します。

  3. インライン コードドキュメントを生成するためのプロンプトを入力します。 たとえば、次のプロンプトを入力できます。

    @workspace /doc Create inline code documentation for the ConsoleApp class.

  4. チャット ビューで、推奨されるインライン コードドキュメントを確認します。

    インライン ドキュメントを提案する Ask モードのチャット ビューを示すスクリーンショット。

  5. 提案されたドキュメントに問題がなければ、提案されたドキュメントを対応するコード ファイルに適用できます。

    推奨されるドキュメントの上にマウス ポインターを置くと、[ 適用]、[ 挿入]、[ コピー ] ボタンが表示されます。 [ 適用 ] ボタンを使用して、推奨されるドキュメントをコード ファイルに適用します。

    [ 挿入 ] ボタンを使用して、現在のカーソル位置にあるエディターに候補を挿入するか、[ コピー ] ボタンを使用して候補をクリップボードにコピーできます。

  6. 提案されたドキュメントをコード ファイルに適用した後、更新を移動して個々の提案を受け入れる、拒否する、または変更することができます。

    Ask モードを使用してエディターに適用されるインライン ドキュメントを示すスクリーンショット。

    一番下のメニュー バーの上下の矢印を使用して、推奨される更新をナビゲートします。

    候補内を移動する際に、候補の上にマウス ポインターを置いたときに表示されるポップアップ メニューを使用して、個々の提案を保持または元に戻すことができます。

    必要に応じて、提案を手動で変更することもできます。

  7. すべての提案を承諾または却下するには、下部のメニュー バーの [保持 ] または [元に戻す ] ボタンを選択します。

    コード エディターでは、必要に応じてドキュメントを引き続き更新できます。

編集モードでチャット ビューを使用してインライン コード ドキュメントを生成する

編集モードのチャット ビューを使用して、コード ファイル、クラス、またはメソッドのインライン コード ドキュメントを生成できます。 コード ファイルを更新する前に、推奨されるインライン ドキュメントを確認し、必要に応じて更新を要求できます。

  1. チャット ビューを Ask モードで開きます。

  2. チャット プロンプトにコンテキストを追加します。 たとえば、[ コンテキストの追加 ] ボタンを選択し、[ エディターを開く ] を選択して、開いているエディター タブをチャットに追加します。

  3. インライン コードドキュメントを生成するためのプロンプトを入力します。

    たとえば、次のプロンプトを入力できます。

    Create inline code documentation for the ConsoleApp class. Document the class, its properties, and methods.

    編集モードでは、 @workspace チャット参加者または /doc スラッシュ コマンドがサポートされていないため、詳細なプロンプトを指定する必要があります。

  4. エディターで、推奨されるインライン コードのドキュメントを確認します。

    インライン ドキュメントを提案する編集モードのチャット ビューを示すスクリーンショット。

  5. 更新を確認して、個々の提案を受け入れる、拒否する、または変更します。

  6. すべての提案を承諾または却下するには、下部のメニュー バーの [保持 ] または [元に戻す ] ボタンを選択します。 チャット ビューの [ 保持 ] または [元に戻す ] ボタンを選択して、すべての提案を承諾または拒否することもできます。

    コード エディターでは、必要に応じてドキュメントを引き続き更新できます。

エージェント モードでチャット ビューを使用してインライン コード ドキュメントを生成する

エージェント モードのチャット ビューを使用して、プロジェクト、コード ファイル、クラス、またはメソッドのインライン コード ドキュメントを生成できます。 コード ファイルを更新する前に、推奨されるインライン ドキュメントを確認し、必要に応じて更新を要求できます。

  1. エージェント モードでチャット ビューを開きます。

  2. チャット プロンプトにコンテキストを追加します。 たとえば、[ コンテキストの追加] ボタンを使用して、ソース コード フォルダーをチャットに追加します。

  3. ドキュメント タスクを定義するプロンプトを入力します。

    たとえば、次のプロンプトを入力できます。

    Create inline code documentation for all C# class files in the specified context. Document the class, properties, and methods. Do not add documentation to JSON, markdown, or other file types. Do not document UnitTest project files in the Test folder. Ensure that the solution builds without errors after the documentation is added.

    エージェント モードでは、 @workspace チャット参加者または /doc スラッシュ コマンドがサポートされていないため、詳細なプロンプトを指定する必要があります。

  4. エージェントは、要求されたタスクを完了すると、チャット ビューにステータス メッセージを表示します。

    ステータス メッセージを示すエージェント モードのチャット ビューを示すスクリーンショット。

    エージェントは、より多くのコンテキストを要求したり、要求されたタスクを完了するための支援を求めたりすることもできます。 たとえば、エージェントは、ターミナルでコマンドを実行する前にアクセス許可を求める場合があります。

  5. エージェントが要求されたドキュメント タスクを完了するのを待ってから、エディターで更新されたファイルを確認します。

    タスク完了後のエージェント モードのチャット ビューを示すスクリーンショット。

    エージェント モードが完了すると、完了したタスクの概要が表示されます。 エディターで更新されたファイルを確認できます。

  6. 更新を確認して、個々の提案を受け入れる、拒否する、または変更します。

    すべての提案を承諾または却下するには、下部のメニュー バーの [保持 ] または [元に戻す ] ボタンを選択します。 チャット ビューの [ 保持 ] または [元に戻す ] ボタンを選択して、すべての提案を承諾または拒否することもできます。

    コード エディターでは、必要に応じてドキュメントを引き続き更新できます。

"Generate Docs" スマート アクションを使用してインライン コード ドキュメントを生成する

[ ドキュメントの生成 ] スマート アクションを使用すると、クラス、メソッド、または複雑なコード ブロックのインライン コード ドキュメントを生成できます。 プロンプトを記述しなくてもドキュメントを簡単に生成できます。 エディターで選択したコードを右クリックすると、コンテキスト メニューで [ドキュメントの生成 ] スマート アクションを使用できます。

[ドキュメントの生成] スマート アクションは、コード エディターでインライン コード ドキュメントを直接提案します。

  1. エディターでコード ファイルを開きます。

  2. 文書化するコードを選択します。

  3. 選択したコードを右クリックし、[ Copilot] を選択し、[ ドキュメントの生成 ] スマート アクションを選択します。

    [ドキュメントの生成] スマート アクションを示すスクリーンショット。

  4. エディターで、推奨されるインライン コードのドキュメントを確認します。

    [ドキュメントの生成] スマート アクションによって提案されたコード ドキュメントを示すスクリーンショット。

  5. [ 同意 する] ボタンを使用して、推奨される更新プログラムを受け入れるか 、[閉じる] を使用して更新を拒否します。

    [ 再実行 ] ボタンを使用して、更新の有無にかかわらずプロンプトを再実行することもできます。

インライン チャットを使用してインライン コード ドキュメントを生成する

インライン チャット機能を使用すると、クラス、メソッド、または複雑なコード ブロックのインライン コード ドキュメントを生成できます。 プロンプトは、コンテキストを指定したり、特定の指示を提供したりするために使用されます。 必要に応じて、 /doc スラッシュ コマンドをテキスト プロンプトなしで使用することもできます。

インライン チャットは、コード エディターで直接インライン コード ドキュメントを提案します。

  1. エディターでコード ファイルを開きます。

  2. 文書化するコードを選択します。

  3. インライン チャット セッションを開始します。

    Ctrl + I キーボード ショートカットを使用するか、[チャット] メニューからエディターインライン チャットを選択します。

  4. インライン コードドキュメントを生成するためのプロンプトを入力します。

    たとえば、メソッドを文書化し、特定の詳細を要求できます。

    Document the selected method. List currentState options

  5. エディターで、推奨されるインライン コードのドキュメントを確認します。

    ドキュメントを提案するインライン チャット セッションを示すスクリーンショット。

  6. [ 同意 する] ボタンを使用して、推奨される更新プログラムを受け入れるか 、[閉じる] を使用して更新を拒否します。

    [ 再実行 ] ボタンを使用して、更新の有無にかかわらずプロンプトを再実行することもできます。

概要

GitHub Copilot は、インライン コードドキュメントを迅速かつ正確に生成するのに役立ちます。 チャット ビュー、インライン チャット、スマート アクション機能は、Visual Studio Code 環境内で直接さまざまなレベルの対話を提供します。