こんにちは！大阪市住之江区に拠点を置く会社『縁紡ぐ』の稲垣です。
当社は、Excel、ACCESS、RPAなどのシステム開発や既存ツールを使った業務効率化の提案、また、ITスキルアップのための教育に力を入れています。効率的なビジネス運営を目指している企業様、ITスキルの向上を図りたい企業や個人の方に、最適なご提案をさせていただきます。業務プロセスの改善とITスキルアップをサポートし、共に成長するパートナーでありたいと考えています。
ExcelVBAで開発：コメントの書き方（テンプレート付）
今回は、プログラミングで重要なコメントについてです。
プログラミングでコメントは重要
まだプログラミングを学んでいない時に、エンジニアさんが後輩のエンジニアさんに指示するときに、
「３日前の自分は、他人。ちゃんと、コメント書きしておいてね！」
と、指示を出していたことをもう１０年以上前のことですが、覚えています。
自分で作成したプログムでも、１か月後、１年後に見ると、なぜこんな処理が書いてあるのかな？
って、経験はプログラミングした方なら誰しもが経験されていると思います。
将来の自分や修正をすることになった他人を助けるためにも、コメント書きはしっかり残すようにしましょう。
プロシージャ等にコメントを残す
まずは、プロシージャ（Sub）や、関数（Function）など、処理に関するコメントを残す方法です。
下の画像のようにコメントを残すと、何のための処理なのかがすぐにわかりますよね？こうすることで、使いまわしすることもやりやすくなります。
将来の自分のために、コメントをしっかり書いておきましょう！下の方に、２つのパターンを作成していますので、どちらかをコピーして、ぜひお使いください。
パターン１
'#######################################
'Details：初回一括登録時に作成する
'Parameter：なし
'Return：なし
'Error:エラー発生行と列をErrorシートに出力し終了する
'memo：T_請求にデータがある場合は、再作成は不可とする
'Crated date: 2024/4/13
'Author: 合同会社縁紡ぐ 稲垣
'Version: 2024/4/20メソッドgetName追加
'#######################################
パターン２
' ==========================================================================
' メソッド名: [メソッド名]
' 概要 : [メソッドの概要を簡潔に記述]
' 作成日 : [作成日]
' 作成者 : [作成者の名前]
' ==========================================================================
' パラメーター:
' - [パラメーター名] ([データ型]): [パラメーターの説明]
' - [パラメーター名] ([データ型]): [パラメーターの説明]
' 戻り値 : [戻り値のデータ型] - [戻り値の説明]
' ==========================================================================
' 修正履歴 :
' - [修正日]: [修正者] - [修正内容の概要]
' - [修正日]: [修正者] - [修正内容の概要]
' ==========================================================================
’パターン２（入力例）
' ==========================================================================
' メソッド名: AddNumbers
' 概要 : 2つの整数を加算し、その結果を返します。
' 作成日 : 2024-07-05
' 作成者 : 稲垣敦
' ==========================================================================
' パラメーター:
' - num1 (Integer): 加算する最初の整数
' - num2 (Integer): 加算する2つ目の整数
' 戻り値 : Integer - 加算結果
' ==========================================================================
' 修正履歴 :
' - 2024-07-05: 稲垣敦 - 初期バージョン作成
' ==========================================================================
’パターン３（入力例）
' ==========================================================================
' 概要 : 2つの整数を加算し、その結果を返します。
' 作成日/作成者 : 2024-07-05 稲垣敦
' 修正履歴 :
' - 2024-07-08: 稲垣敦 -Long型に変更
' ==========================================================================
Public Function AddNumbers(num1 As Integer, num2 As Integer) As Integer
AddNumbers = num1 + num2
End Function処理中のコメントの書き方
次はプログラムの処理の中にコメントを書く方法です。
ブロックごとに何をしている処理かをコメントしています。こうすることで、不具合等があってもどこら辺に誤りがあるのかをすぐに見つけやすくなります。
見たらすぐにわかるコメントはしない
下の図のように、コードを見たらすぐわかるようなコメントは不要です。
不要なコメントか、迷ったときは書いておきましょう！書かなくて、わからないようになるより書いてある方が、絶対に損はしないです。
大切なこと
VBAで作成した処理を将来修正することは、当たり前のように発生してきます。
そして、自分が書いたコードなのに、「？？？？？？？？？？」が飛び回ることも、当たり前のようにあります。
将来の自分のため、自分が大切に作ったコードを修正できず捨てられることのないように、しっかりコメントを残すようにしましょう！
稲垣
- Excel、ACCESSでのシステム開発が得意
- ITスキルを共有し実践的に学びながら成長する人を見るのが幸せ
- 自家焙煎するほどのコーヒー好き
- 使用言語 VBA、Python、Javascript、Java、HTML、CSS etc.
- 保有資格 Kintoneアソシエイト、日商簿記検定２級、マンション管理士、管理業務主任者、情報セキュリティマネジメント、ExcelVBA etc.
- 業務フロー図の作成や業務時間分析を通して、効率化ポイントを探る人
- お客様にとって本当に良いことかを第一に考える人
コメント