コメントを生成する

GitHub Copilot では、 ソースコードだけではなく、 プログラムのコメントも 入れることができます。 画面は、Codespaces で Visual Studio Code を 開いた状態です。 拡張機能として C# Dev Kit をインストールすると 合わせてインストールされる C# 系の拡張機能、 そして GitHub Copilot、 そして今回は Python も利用するので Python 用の拡張機能の３つが インストールされています。 それでは、 GitHub Copilot を利用して Python のメソッドと C# で書かれたメソッドの２つに コメントを入れてみましょう。 まずは、ReadFile.py という Python のコードを開きます。 左側のアイコンから 「チャット」を選択して、 GitHub Copilot チャットを 起動しましょう。 そして、質問を送ります。 read_json_file メソッドに コメントを入れてください。 Copilot に問い合わせを行います。 そうすると、このように コメントを提案してくれます。 Python 形式の コメントの書き方になっています。 メソッドにコメントを適用してみました。 ちゃんとこのメソッドが JSON ファイルを読み込み、 Python のデータコードに 変換することをコメントで説明しています。 そして、引数や戻り値の説明も 付け加えています。 もうひとつ、今度は C# のプログラムコードに コメントを入れてみましょう。 Copilot チャットを見やすいように 横に広く展開します。 ReadFileFromPath メソッド こちらにコメントを入れてください。 もう一度、Copilot に 問い合わせを行ってみます。 すると、今回はちゃんと C# のコードであると判断して C# のドキュメント形式の コメントを返してくれました。 コメントを適用してみましょう。 このようにメソッドの概要は <summary> で囲み、 そして、param というタグで 引数の説明を、 そして、<returns> というタグで 戻り値の説明をしています。 このように C# のコードであれば、 それに合わせた コメントを提案してくれます。 このように GitHub Copilot は…