こんんちは。テレワーカーＹです。
マクロを書く際のコメントの取り扱いについて考えてみました。コメントの多い少ないと読みやすさとの関係を図にしてみました。これを’Comment Readability Matrix'(CRM、コメント読みやすさ相関図)と呼ぶことにします。
そもそもが、あまりコメントがいらないシンプルなコードこそが、望ましいものだと考えます。ただ、そうは言っても、場合によってはコードに表現しきれない部分もあろうかと思います。その場合は(最小限の)コメントを付けるのは、望ましいことです。したがって、マクロが管理しやすいのは「シンプルなコード」と「適切なコメント」のところです。
読みにくくてコメントも少ないコードが、「カオス」に分類されます。もともと考えを整理しないで書いたり、前任者からコードを引き継いだ担当者がつぎはぎを繰り返すと、コードはカオス化します。
また、コメントをやたらと入れるのも(コメント中毒)考えものです。とにかくコメントはあった方が良いという考える方もいらっしゃるかもしれませんが、本当にそうでしょうか？コード自体が読みやすければ、そんなにコメントばかりにならないように思うのですが……。それにコメントは入れれば入れるほど、コメント自体のメンテナンスに手間がかかります。メンテナンスされていないコメントは百害あって一利無しと考えます。
これまで業務でVBAを書いてきて、ずっとどのようなコメントを書かなければならないのか悩んできたのですが、今はほとんど書かなくなりました。その代わり、自分なりの命名規則などのコーディング標準に則って、読みやすさに注意してコーディングしているつもりです。後で自分のコードを見て、よく判らないということもまずないです。この自分の中にあるコーディング標準は、今後ブログにちょっとずつ著していって、どこかでまとめたいと思っています。
コメント