VBAコードには適切なコメント文を残そう

VBAコーディングの際に、適切なコメント文を残す意義を解説します。「コメント文」は、VBAコード内に記述される実行されることのないコードです。

実行されないとはいえ、VBAコードの開発や改修を行う上で非常に大切なものになりますので、その大切である理由を含めて、今回は「コメント文」についてお話ししたいと思います。

それでは、久しぶりになりますが、次のコードを真似て書いてみてください。

書けましたでしょうか？では今回初めてになります「コメント文」について、お話しますね。

コメント文

今回のコードを書きうつしていた際、2, 6, 9行目の先頭に「'」（シングルコーテーション）がついているのに気づかれたかと思います。これは、VBAコードの中に説明やメモ書きとして書き込むときに使う「コメント文」と呼ばれるものです。

このコメント文は、コードの実行には何も影響を与えませんので、モジュール上の好きな位置に書くことができます。

これにより、数百行にもおよぶコードに対して、適宜コメント文を入れることで、コードの可読性を保つ大切な役割をします。

コメント文が大切な理由

ここで「大切」といいましたのは、コメント文を適切に入れることにより、以下の問題に対処することができるからです。

全くコメント文がない、あっても理解不能、あるいはコメント文が少ないコードは、

• たとえ自分で書いたコードでさえ、時間が経つほど後で見た時に思い出すのに時間がかかる
• 業務を引き継ぐ人が、コードが理解できず、結局そのコード自体を業務で使わなくなるリスクがある

以上より、理解不能や理解に時間のかかるコメント文は、結果的に集計業務の効率改善に繋がらなくなってしまうような事態になる可能性もあります。

実は、これらはわたしの苦い経験でもあるのですが、10年程前、忙しい最中、コードを早く書いて、業務効率に反映させようという気持ちが強く、コメント文をあまり残さなかったり、自分しか理解できないような内容のコメント文を書いていました。

その結果、わたしが退職する際に、引き継ぐ者に付きっきりで1か月ほどレクチャーした記憶があります。この時、適切なコメント文（当然他人が読んでも理解できるもの）や、ドキュメントを残しておけば良かったなぁと痛感しました。

どういうコメント文が良いのか

先ほど述べましたように、いくらコメント文があっても、他人が読んで理解不能な、いわゆる自分向けのメモや備忘録みたいなのは、誤解や読解に時間がかかり、結局コードの詳細を見ないと何がしたいのか分からなかったりします。

ですので、わたしは以下の事を心掛けてコメント文を残しています。

• コードを読まなくても、コメント文だけでコードのロジックや流れを把握できる
• 「何の目的で書いたコードなのか」を他人に伝える意識で書く
• 冗長にならないよう、簡潔に伝える

一文でまとめると「読むだけでロジックの流れが伝わる簡潔なコメント文を適宜入れる」ような意識でコメントを入れています。

まとめ

コメント文は、引き継ぎ担当者や未来の自分のために、VBAコードで書かれた内容を、効率よく伝える手段の一つです。わたしもコメント文をあまり残さずに、痛い思いをした経験があります。

みなさんは、自分はVBAコードで何がやりたいのかが、人に理解されやすい適切なコメント文を書くようにしてくださいね。