ExcelVBAで開発：コメントを書き方（テンプレート付）

ExcelVBAで開発：コメントを書き方（テンプレート付）

今回は、プログラミングで重要なコメントについてです。

プログラミングでコメントは重要

まだプログラミングを学んでいない時に、エンジニアさんが後輩のエンジニアさんに指示するときに、

「３日前の自分は、他人。ちゃんと、コメント書きしておいてね！」

と、指示を出していたことをもう１０年以上前のことですが、覚えています。

自分で作成したプログムでも、１か月後、１年後に見ると、なぜこんな処理が書いてあるのかな？

って、経験はプログラミングした方なら誰しもが経験されていると思います。

将来の自分や修正をすることになった他人を助けるためにも、コメント書きはしっかり残すようにしましょう。

プロシージャ等にコメントを残す

まずは、プロシージャ（Sub）や、関数（Function）など、処理に関するコメントを残す方法です。

下の画像のようにコメントを残すと、何のための処理なのかがすぐにわかりますよね？こうすることで、使いまわしすることもやりやすくなります。

将来の自分のために、コメントをしっかり書いておきましょう！下の方からコピーできますので、ぜひお使いください。

Option Explicit
'#######################################
'Details：初回一括登録時に作成する
'Parameter：なし
'Return：なし
'Error:エラー発生行と列をErrorシートに出力し終了する
'memo：T_請求にデータがある場合は、再作成は不可とする
'Crated date: 2024/4/13
'Author: 合同会社縁紡ぐ　稲垣
'Version:　2024/4/20メソッドgetName追加
'#######################################
Sub createHeyaList()

'処理

End Sub

処理中のコメントの書き方

次はプログラムの処理の中にコメントを書く方法です。

ブロックごとに何をしている処理かをコメントしています。こうすることで、不具合等があってもどこら辺に誤りがあるのかをすぐに見つけやすくなります。

見たらすぐにわかるコメントはしない

下の図のように、コードを見たらすぐわかるようなコメントは不要です。

不要なコメントか、迷ったときは書いておきましょう！書かなくて、わからないようになるより書いてある方が、絶対に損はしないです。

大切なこと

VBAで作成した処理を将来修正することは、当たり前のように発生してきます。

そして、自分が書いたコードなのに、「？？？？？？？？？？」が飛び回ることも、当たり前のようにあります。

将来の自分のため、自分が大切に作ったコードを修正できず捨てられることのないように、しっかりコメントを残すようにしましょう！