GitHub Copilotでコメントを生成する

GitHub Copilot を利用して プログラムコードにコメントを 入れることができます。 今回は、２つのファイルに コメントを入れてみましょう。 ひとつは WeatherForecastController.cs、 もうひとつは Employee.cs です。 まずは、WeatherForecastController.cs に コメントを入れてみましょう。 ただし、このクラスには問題があり、 このクラスはプロジェクトを作成する際に 出来るテンプレートのクラスです。 WeatherForecast という 文字からもわかるように、 天気に関する処理を行なう テンプレートでした。 今回は、あえてそのまま クラス名を残してあります。 Copilot に質問を送りましょう。 コントローラー名をコピーして 「WeatherForecastController クラスに コメントを入れてください」と 送りましょう。 GitHub Copilot から 回答が返ってきました。 コメントの形式は C# のドキュメント形式で 正しいのですが、 コメントの中身を見ると、 「天気予報のデータを管理します。」と 書いてあります。 実際のプログラムコードは、 実は、従業員を表す Employee のデータを 介しているような処理が、 書かれているコードでした。 GitHub Copilot は、 クラス名やファイル名から このファイルの内容を推測して、 コメントを提案してくれました。 もうひとつ、Employee.cs にも コメントを入れてみましょう。 「Employee クラスに コメントを入れてください」 こちらも GitHub Copilot に 問い合わせを行います。 このようにコメントのひな形を 提示してくれました。 プロパティに関しては すべてではないので、 追加で質問を行うと 他のプロパティに関してのコメントも 得ることができますが、 まずは、内容を確認してみましょう。 コメントは 「従業員のデータを管理するクラスである」 というようなコメントになっています。 これはファイル名もクラス名も 用途に合っているので、 正しいコメントを得ることができました。 他のプロパティのコメントも 確認しましょう。 「Employee クラスの Id、Name、Age…