プログラミングにおいて、綺麗で読みやすいコードを書くことは非常に大事です。
「今動けば良いや」と適当にコードを書いた場合、1か月後に読み直すとさっぱり意味不明なことが多いです。
改修の手間やバグを減らすためにも、読みやすい綺麗なコードを心がけましょう。
インデント
VBAは自動インデント（タブ）が挿入されないため、慣れるまではインデントせずに書いてしまいがちです。
以下のようにきっちりタブを入れることを心がけましょう。
コメント（関数）
コメントも非常に大事です。
コメントを読むだけで処理内容が理解できるようにしておきます。
まず、関数上部にはその関数でやっている処理の概要を記述します。
引数、戻り値なども記載しておきましょう。
引数、戻り値は@params、@returnなどで記載しても良いかと思いますが、私は分かりやすさ重視のためにこのように日本語で書いています。
関数内部にもコメントを適宜記載します。
ただし、極論的には関数内部にコメントがなくても処理概要が理解できるぐらいシンプルに処理を書くのが理想です。
コメント（モジュール上部）
モジュール上部のコメントには、そのモジュールでやっている処理の概要を記述します。
コメントだけで全体像が理解できるようにしておきます。
また、他モジュールから呼び出せるグローバル関数には番号を振って索引を書いておきます。
こうすることで、関数が増えてきた際にも迷子になりません。
分かりやすい名前を付ける
モジュール、関数は適切に分割し、分かりやすい名前を付けます。
関数名や変数名の付け方も非常に大事です。
一貫性のあるネーミングルールを使いましょう。これについては別記事で説明します。
1行の処理はできるだけシンプルに
1つの行が長くなりすぎるようなコードもNGです。
1行の処理が複雑になりすぎた場合、複数行に分割して各行にコメントを付けてやります。
常にシンプルにコードを書くのが理想です。
まとめ
保守の観点から考えると、処理内容は一目見ただけで分かるようにするのが理想です。
常に保守のことを考えてコードを書くように心掛けましょう。
まとめ
・インデントを丁寧に付ける
・関数、モジュールには処理概要のコメントを付ける
・コードは適切に分割し、分かりやすい名前を付ける
・1行の処理は出来るだけシンプルに