ChatGPTを活用したコードレビューとリファクタリングによるスキル向上手順

2024年8月30日

C#のプログラミングを始めたばかりの初心者にとって、コードを美しく保つことは非常に重要です。美しいコードとは、読みやすく、メンテナンスしやすいコードのことです。この技術文書では、ChatGPTを活用してコードをレビューし、リファクタリング案を得ることで、徐々に美しいコードを書くスキルを身につける手順を紹介します。

1. 1. 手順概要
2. 2. 手順詳細
3. 3. 注意点
4. 4. まとめ

1. 手順概要

この手順では、まず自分で書いたコードをChatGPTに貼り付け、レビューを依頼します。その後、ChatGPTからのフィードバックを基にコードを改善し、再度レビューを行います。これを繰り返すことで、コードの質を向上させることができます。

2. 手順詳細

2.1 コードを貼り付ける

まず、あなたが書いたC#コードをChatGPTに貼り付けます。以下に例を示します。

using System;

class Program
{
    static void Main()
    {
        int number = 5;
        if (number == 5)
        {
            Console.WriteLine("Number is five");
        }
    }
}

2.2 ChatGPTにレビューを依頼する

貼り付けたコードに対して、次のようにレビューを依頼します。

例: 「このコードの改善点があれば教えてください。」

2.3 ChatGPTからのフィードバックを確認する

ChatGPTは、コードのレビュー結果を返してくれます。例えば、次のようなフィードバックが得られるかもしれません。

フィードバック例: 「このコードはシンプルで理解しやすいですが、文字列をハードコーディングするのではなく、定数として定義すると良いでしょう。」

2.4 コードをリファクタリングする

フィードバックを基に、コードをリファクタリングします。例えば、先ほどのフィードバックに基づいて次のようにコードを改善します。

using System;

class Program
{
    private const string Message = "Number is five";

    static void Main()
    {
        int number = 5;
        if (number == 5)
        {
            Console.WriteLine(Message);
        }
    }
}