コードを読み返すときにもChatGPTは大活躍！コメントも書いてもらおう

みなさん、こんにちは！タカハシ(@ntakahashi0505)です。

前回はChatGPTのファイルアップロードの機能を紹介しました。

さて、プログラムはつくったら終わり、ではなくて使い続けるうちに「保守」が必要になります。

そして、そのときプログラムのコードを読み返す必要があるのですが、「よ、読めない…」というときが少なくありません。

そんなときに、たよりになるのがChatGPT。今回は、コードを読み返すときのChatGPTの活用法についてご紹介します。

ということで、今回は「コードを読み返すときにもChatGPTは大活躍！コメントも書いてもらおう」についてお伝えします。

では、行ってみましょう！

コードを読み返す際の課題と解決策
ChatGPTにコードを解説してもらう
ChatGPTにコメントを追記してもらう
まとめ
連載目次：【初心者向け】ノンプログラマーのChatGPT活用術

コードを読み返す際の課題と解決策

少なくない初心者ノンプログラマーは、プログラムがつくれて動いたらそれでOK！…となりがちですが、残念ながらそうはいきません。

業務には変化がつきものですし、追加の要望も出てきます。何らかの影響で不具合が見つかることもあります。

つまり、「保守」が必要なのです。

書いたときにはばっちり理解していたコードも、時間が経つと「あれ、この処理って何をしてたんだっけ？」と、コードが読み解けないという状況にしばしばなりがちです。

そこで役立つのがChatGPTです。

ChatGPTにコードを解説してもらう

これまでは、時間が経っても、コードを見返しやすいように、読みやすいコード（＝リーダブルコード）を書くことが重要とされてきました。

もちろん、そう書けるに越したことはありませんが、今であればChatGPTを力を借りることができます。

もし、コードが読めなくなってしまったとしても、ChatGPTに解説を依頼することで簡単に記憶を取り戻せます。

例えば、以下のようにコードをChatGPTに解説してもらうことができます。

以下のコードを簡潔に解説してください。

# コード
Sub CopyToNewSheet()
    Dim selectedRange As Range
    Dim newSheet As Worksheet

    Set selectedRange = Selection
    selectedRange.Copy

    Set newSheet = ThisWorkbook.Sheets.Add
    newSheet.Range("A1").PasteSpecial

    MsgBox "選択した範囲を新しいシートにコピーしました"
End Sub

すると、以下のような回答が得られます。

このVBAコードは、選択した範囲を新しいシートにコピーするマクロです。

1. 変数の宣言とセットアップ:
・selectedRangeは、ユーザーが選択したセルの範囲を保持します。
・newSheetは、新しく作成するワークシートを表します。

2. 選択範囲のコピー
・SelectionはExcelでユーザーが選択したセルや範囲を表し、それをselectedRangeに設定します。
・その後、選択範囲をコピーします。
（以下略）

忘れていたとしても、これだけガッツリ解説してもらえれば、さすがに思い出せますよね。

ChatGPTにコメントを追記してもらう

さらに、ChatGPTを使ってコードにコメントを追加することも非常に便利です。

コメントというのは、プログラムの中に書き込める「メモ書き」です。日本語でメモを書いておけば、わざわざChatGPTに尋ねなくても、コメントを頼りにコードを読み解くことができます。

プログラムにコメントが入れたいときは、次のようにプロンプトを使ってコメントを追加してもらえます。

以下のコードにコメントを追記してください。

# コード
Sub CopyToNewSheet()
    Dim selectedRange As Range
    Dim newSheet As Worksheet

    Set selectedRange = Selection
    selectedRange.Copy

    Set newSheet = ThisWorkbook.Sheets.Add
    newSheet.Range("A1").PasteSpecial

    MsgBox "選択した範囲を新しいシートにコピーしました"
End Sub

すると、以下のようにコメントを挿入したプログラムを出力してくれます。

以下に、各行ごとにコメントを追加したコードを示します。

Sub CopyToNewSheet()
    ' 選択範囲と新しいシートのための変数を宣言する
    Dim selectedRange As Range
    Dim newSheet As Worksheet

    ' 現在の選択範囲を取得して、それをコピーする
    Set selectedRange = Selection
    selectedRange.Copy

    ' 新しいシートを作成し、そのシートのA1セルにコピーした範囲を貼り付ける
    Set newSheet = ThisWorkbook.Sheets.Add
    newSheet.Range("A1").PasteSpecial

    ' 処理が完了したことをユーザーに通知するメッセージボックスを表示する
    MsgBox "選択した範囲を新しいシートにコピーしました"
End Sub

また、プログラム作成時に「コメントも追記してください」と条件を追加しておくのもよいですね。

なお、ChatGPTの有料プランで使用できる「canvas」では、右下のショートカットボタンにそもそも「コメントを追加してください」のボタンがあるので、canvasに貼り付けたコード全体へのコメント追記をサクッと行えます。