初心者から実務利用者まで
わかりやすいVBA解説サイト
コラム

コメントに「○行目参照」「○番目の処理」など番号を書かない

ひとみさんがマクロを作成中、コメントを書いています。
一生懸命わかりやすくしようと工夫をしているようですが…

ひとみさん
ひとみさん
この処理は5行目の変数を参照しているので
後で見てわかりやすいように
「5行目の変数を参照」と
コメントしておけば大丈夫ですね!
遥先生
遥先生
あら、そのコメントの書き方はNGよ

コードは将来変わる可能性がある

コメントは後で見た人がマクロを理解するために、
なるべくわかりやすく書きたいものです。

しかし、この様なコメントを残してしまうと

今後メンテナンスや改築により
マクロのコードが増えた場合、
変数dが10行目や20行目に移動してしてしまった場合、
コメントも書き換える必要があります。

もし、書き換えを忘れてしまった場合
10行目というミスリードがコメントに残るため
わかりやすくしようと思って書いたコメントのせいで
後で見た人が余計に混乱をしてしまいます。

「〇番目の処理」などもNG!

同様に、処理の順番などを数字でコメントする事も避けましょう。

こちらも同様の理由で、途中で処理を追加した場合に
コメントも書き換えなくてはならなくなるためです。

今はコードが絶対増えないという自信があっても
将来的に何があるかはわかりません。

また、そのマクロではコードが増えなくても
別のマクロでは増えることがあるかもしれません。
普段から意識をして悪いクセをつけないことが大事です。

管理の手間を少なくすることを考えてマクロを作る

マクロの作成者と管理者が同じ場合は
将来メンテナンスを行った時に作業するのも
作成者、自分自身です。

将来の自分や後でマクロを見た人が
少しでも苦労しないコメントの書き方を
意識しましょう。

遥先生
遥先生
わかりやすくすることも大事だけど
管理の手間を減らすことも考えるのよ。
ひとみさん
ひとみさん
将来メンテナンスしやすいように
作る事が大事なんですね!