VBAのコメントの書き方|’の使い方とメンテナンスしやすいコードにするコツ

VBAでコードを書いていると、その場では理解していても、数週間後には「この処理、なんでこうなってたんだっけ?」と思い出せなくなることがあります。また、他の人が引き継いだとき、「何をしているか」「なぜやっているか」がわからないコードは修正するのも不安です。

そんな問題を防ぐのがコメント(' から始まる説明文)です。この記事では、効果的なコメントの書き方を具体例とともに解説します。

VBAのコメントを書くには?

行の先頭または文の後ろに '(シングルクォーテーション)を書くと、そこから行末までがコメントとして扱われ、実行時には無視されます。

' B1〜B10の合計をA1セルに表示
Range("A1").Value = WorksheetFunction.Sum(Range("B1:B10"))

コメントがあるだけで、コードを読む人(未来の自分も含む)が処理の内容をひと目で把握できるようになります。

処理の「なぜ」を書いて理解しやすくするには?

「何をしているか」だけでなく、「なぜそうしているか」を書くとより効果的です。

' コメントなし
Application.ScreenUpdating = False

' コメントあり
' 画面の更新を止めて処理を高速化する
Application.ScreenUpdating = False

「設定を変えているだけ」に見えるコードも、理由が書いてあると意図が伝わりやすくなります。修正や仕様変更のときにも「ここを変えていいかどうか」の判断がしやすくなります。

コードのブロックを区切りで見やすくするには?

処理のまとまりの先頭にコメントを入れると、コード全体の構造を把握しやすくなります。

' ---------- データ抽出処理 ----------
' A列が空欄でない行だけを別シートにコピーする
For i = 2 To lastRow
    If Cells(i, 1).Value <> "" Then
        ' 処理内容...
    End If
Next i

長いマクロでは、こうした区切りコメントがあると「今どのセクションを読んでいるか」がわかりやすくなります。

NGコメントの例と改善方法とは?

コメントを書いても、次のような書き方では意味が薄くなります。

' 設定      ← 何の設定かわからない
x = 1

' ここで処理をする    ← 具体性がなく何も伝わらない
Call 処理A

コメントは「読んだ人が安心できる説明」を意識して書くのがポイントです。曖昧な言葉や長すぎる説明は逆効果になります。

効果的なコメントを書くための4つのルールとは?

読みやすいコメントには共通したルールがあります。

① なぜその処理をするかを書く
「何をしているか」はコード自体を読めばわかります。コメントには「なぜそうしているか」の情報を加えましょう。

② 変数の用途や特殊な処理には説明を添える
意図がわかりにくい変数名や処理の前後に一言添えるだけで理解度が変わります。

③ 1〜2行で簡潔に書く
長すぎるコメントはかえって読みにくくなります。要点を絞って短くまとめましょう。

④ 1つのマクロに最低1つ以上入れる
最初は「何のためのマクロか」を先頭に書くだけでも十分です。

まとめ

  • コメント' から行末まで。実行時には無視される
  • 「何をしているか」ではなく「なぜそうしているか」を書くと効果的
  • 処理ブロックの先頭に区切りコメントを入れるとコードの構造が見やすくなる
  • 曖昧・長すぎ・意図不明なコメントは逆効果。1〜2行で簡潔に書く
  • コードを修正したらコメントも一緒に更新することが大切

よくある質問

コメントはすべての行に書く必要がありますか?

不要です。意図が明確な処理にコメントを書いてもノイズになるだけです。「なぜこう書くのか」が伝わりにくい箇所や、処理のまとまりの先頭に絞って書くのが効果的です。

コメントを書いても実行速度に影響しますか?

影響しません。コメントはVBAの実行時には完全に無視されます。どれだけ長く書いても処理の速度には関係ないため、必要と思う場所には遠慮なく書いてください。

ブロックコメントを一括でつけたり外したりできますか?

できます。VBEエディタの「表示」→「ツールバー」→「編集」でツールバーを表示すると、選択範囲をまとめてコメントアウト・解除するボタンが使えるようになります。デバッグ時に重宝します。

英語でコメントを書くべきですか?日本語でもいいですか?

チームで使うコードの場合はルールを統一するのが理想ですが、個人や社内利用であれば日本語で書いて問題ありません。読む人が理解できる言語で書くことが最優先です。

古いコメントが残っているとどんな問題がありますか?

処理内容と合わなくなった「嘘のコメント」が残ると、読む人を混乱させます。コードを修正したときはコメントも一緒に見直す習慣をつけましょう。


動画で学びたい方へ

「記事を読んでも、実際に自分で書けるか不安…」という方には、動画で基礎からじっくり学べる講座がおすすめです。

VBAが初めての方を前提に、つまずきやすいポイントを先回りして解説しています。サンプル動画は無料でご覧いただけます。

動画で学ぶExcelマクロ|JIMOVEオンラインスクール

コメントする

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

上部へスクロール